@fluidframework/react 0.41.4 → 2.63.0-358419

package/src/syncedObjects/counter/fluidSyncedCounter.ts

@@ -1,122 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { SharedCounter } from "@fluidframework/counter";
-import {
-    IViewState,
-    IFluidState,
-    ICombinedState,
-    IFluidDataProps,
-    useReducerFluid,
-    SyncedDataObject,
-} from "../..";
-import { IFluidSyncedCounterReducer } from "./interface";
-
-export function setFluidSyncedCounterConfig<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    viewKey: keyof SV,
-    fluidKey: keyof SF,
-    defaultViewState: SV,
-    sharedObjectCreate = SharedCounter.create,
-) {
-    syncedDataObject.setFluidConfig<SV, SF>(syncedStateId, {
-        syncedStateId,
-        fluidToView: new Map([
-            [
-                fluidKey,
-                {
-                    type: SharedCounter.name,
-                    viewKey,
-                    viewConverter: (viewState, fluidState) => {
-                        if (fluidState[fluidKey] === undefined) {
-                            throw Error("Fluid state was not initialized");
-                        }
-                        viewState[viewKey] = (fluidState[
-                            fluidKey
-                        ] as any).value;
-                        return viewState;
-                    },
-                    sharedObjectCreate,
-                    listenedEvents: ["incremented"],
-                },
-            ],
-        ]),
-        viewToFluid: new Map([
-            [
-                viewKey,
-                {
-                    type: "number",
-                    fluidKey,
-                    fluidConverter: (viewState, fluidState) => {
-                        if (fluidState[fluidKey] === undefined) {
-                            throw Error("Fluid state was not initialized");
-                        }
-                        viewState[viewKey] = (fluidState[
-                            fluidKey
-                        ] as any).value;
-                        return fluidState;
-                    },
-                },
-            ],
-        ]),
-        defaultViewState,
-    });
-}
-
-export function generateSyncedCounterReducer<
-    SV extends IViewState,
-    SF extends IFluidState
->(viewKey: keyof SV, fluidKey: keyof SF): IFluidSyncedCounterReducer<SV, SF> {
-    const syncedCounterReducer = {
-        increment: {
-            function: (state, step: number) => {
-                if (state?.fluidState?.[fluidKey] === undefined) {
-                    throw Error(
-                        "State was not initialized prior to dispatch call",
-                    );
-                }
-                const counter = state.fluidState[fluidKey];
-                counter.increment(step);
-                state.viewState[viewKey] = counter.value;
-                return { state };
-            },
-        },
-    };
-    return syncedCounterReducer;
-}
-
-export function useSyncedCounterReducerFluid<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    viewKey: keyof SV,
-    fluidKey: keyof SF,
-    defaultViewState: SV,
-// eslint-disable-next-line @typescript-eslint/ban-types
-): [ICombinedState<SV, SF, IFluidDataProps>, IFluidSyncedCounterReducer<SV, SF>, {}] {
-    const syncedCounterReducer = generateSyncedCounterReducer(viewKey, fluidKey);
-    return useReducerFluid<
-        SV,
-        SF,
-        IFluidSyncedCounterReducer<SV, SF>,
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        {},
-        IFluidDataProps
-    >(
-        {
-            syncedDataObject,
-            syncedStateId,
-            reducer: syncedCounterReducer,
-            selector: {},
-        },
-        defaultViewState,
-    );
-}

package/src/syncedObjects/counter/index.ts

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

package/src/syncedObjects/counter/interface.ts

@@ -1,44 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ISharedCounter } from "@fluidframework/counter";
-import {
-    IViewState,
-    IFluidState,
-    IFluidReducer,
-    IFluidDataProps,
-    FluidStateUpdateFunction,
-} from "../..";
-
-/**
- * The state interface exposed to the view for the synced counter
- */
-export interface ISyncedCounterViewState extends IViewState {
-    value: number;
-}
-
-/**
- * The state interface for the Fluid data source that powers the synced counter
- */
-export interface ISyncedCounterFluidState extends IFluidState {
-    counter: ISharedCounter;
-}
-
-/**
- * The reducer interface for incrementing the synced counter
- */
-export interface ISyncedCounterReducer {
-    increment: (step: number) => void;
-}
-
-/**
- * The underlying reducer interface passed to the useReducerFluid hook to bind the view and Fluid
- * state definitions together
- */
-export interface IFluidSyncedCounterReducer<
-    SV extends IViewState,
-    SF extends IFluidState
-    > extends IFluidReducer<SV, SF, IFluidDataProps> {
-    increment: FluidStateUpdateFunction<SV, SF, IFluidDataProps>;
-}

package/src/syncedObjects/counter/syncedCounter.ts

@@ -1,64 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
-import { SharedCounter } from "@fluidframework/counter";
-import { SyncedDataObject } from "../..";
-import { ISyncedCounterViewState, ISyncedCounterFluidState, ISyncedCounterReducer } from "./interface";
-import { setFluidSyncedCounterConfig, useSyncedCounterReducerFluid } from "./fluidSyncedCounter";
-
-/**
- * Function to set the config for a synced counter on a syncedDataObject's SharedMap synced state. This
- * will initialize and provide a SharedCount for the view to use. This SharedString provided is automatically
- * bound to the state update of the functional view useSyncedCounter is called in.
- * @param syncedDataObject - The Fluid data object on which the synced state config is being set
- * @param syncedStateId - The ID of the view state that this config schema is being set for
- * @param defaultValue - The default number the view value will be set to prior to the Fluid counter initializing
- * @param sharedObjectCreate - The creation function for the SharedCounter. This can be set to pre-increment the counter
- */
-export function setSyncedCounterConfig(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    defaultValue: number = 0,
-    sharedObjectCreate: (runtime: IFluidDataStoreRuntime) => SharedCounter = SharedCounter.create,
-) {
-    setFluidSyncedCounterConfig<ISyncedCounterViewState, ISyncedCounterFluidState>(
-        syncedDataObject,
-        syncedStateId,
-        "value",
-        "counter",
-        { value: defaultValue },
-        sharedObjectCreate,
-    );
-}
-
-/**
- * Function to use the synced counter state powered by a SharedCounter that has been prepared for this view
- * @param syncedDataObject - The Fluid data object that holds the synced state config for this view
- * @param syncedStateId - The ID of this view state
- * @returns [
- *  the number that the SharedCounter has been incremented to,
- *  the reducer to modify the SharedCounter by incrementing it
- * ]
- */
-export function useSyncedCounter(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    defaultValue: number = 0,
-): [number, ISyncedCounterReducer] {
-    type viewState = ISyncedCounterViewState;
-    type fluidState = ISyncedCounterFluidState;
-    const [state, fluidReducer] = useSyncedCounterReducerFluid<viewState, fluidState>(
-        syncedDataObject,
-        syncedStateId,
-        "value",
-        "counter",
-        { value: defaultValue },
-    );
-    const reducer: ISyncedCounterReducer = {
-        increment: (step: number) => fluidReducer.increment.function(state, step),
-    };
-
-    return [state.viewState.value, reducer];
-}

package/src/syncedObjects/index.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-export * from "./array";
-export * from "./counter";
-export * from "./string";
-export * from "./object";

package/src/syncedObjects/object/index.ts

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

package/src/syncedObjects/object/interface.ts

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IFluidReactState } from "../..";
-
-/**
- * The synced state definition that will fill the value parameter with the type T object that will be
- * defined in the synced state config
- */
-export interface ISyncedMapState<T> extends IFluidReactState {
-    value: T;
-}

package/src/syncedObjects/object/syncedObject.ts

@@ -1,55 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { SyncedDataObject } from "../..";
-import { useStateFluid } from "../../useStateFluid";
-import { ISyncedMapState } from "./interface";
-
-/**
- * Function to set the config for any type T object on a syncedDataObject's SharedMap synced state
- * @param syncedDataObject - The Fluid data object on which the synced state config is being set
- * @param syncedStateId - The ID of the view state that this config schema is being set for
- * @param defaultValue - The default value of type T that the state will be initialized with prior to
- * Fluid initialization
- */
-export function setSyncedObjectConfig<T>(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    defaultValue: T,
-) {
-    syncedDataObject.setConfig<ISyncedMapState<T>>(syncedStateId, {
-        syncedStateId,
-        fluidToView: new Map([
-            [
-                "value", {
-                    type: "any",
-                    viewKey: "value",
-                },
-            ],
-        ]),
-        defaultViewState: { value: defaultValue },
-    });
-}
-
-/**
- * Function to use the synced state of type T that has been prepared for this view
- * @param syncedDataObject - The Fluid data object that holds the synced state config for this view
- * @param syncedStateId - The ID of this view state
- * @param defaultValue - The default value of type T that the view state will be initialized with
- * @returns [the initialized synced state of type T, a synced setState call for the state]
- */
-export function useSyncedObject<T>(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    defaultValue: T,
-): [T, (newState: T) => void] {
-    const [state, setState] = useStateFluid<ISyncedMapState<T>, ISyncedMapState<T>>(
-        {
-            syncedDataObject,
-            syncedStateId,
-        }, { value: defaultValue },
-    );
-    return [state.value, (newState: T) => setState({ value: newState })];
-}

package/src/syncedObjects/string/index.ts

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

package/src/syncedObjects/string/interface.ts

@@ -1,17 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { SharedString } from "@fluidframework/sequence";
-import { IFluidReactState } from "../..";
-
-/**
- * The state definition for a synced string
- * TODO: Add a proper SharedString to string mapping but, for now, you can pass the pre-initialized SharedString
- * directly into the CollaborativeInput provided by the react-inputs package from within
- * the React functional view useSyncedString is called in
- */
-export interface ISyncedStringState extends IFluidReactState {
-    value?: SharedString;
-}

package/src/syncedObjects/string/syncedString.ts

@@ -1,61 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { SharedString } from "@fluidframework/sequence";
-import { SyncedDataObject } from "../..";
-import { useStateFluid } from "../../useStateFluid";
-import { ISyncedStringState } from "./interface";
-
-/**
- * Function to set the config for a synced string on a syncedDataObject's SharedMap synced state. This
- * will initialize and provide a SharedString for the view to use. This SharedString provided is automatically
- * bound to the state update of the functional view useSyncedString is called in. It can also easily be placed
- * in a CollaborativeInput within a React view.
- * @param syncedDataObject - The Fluid data object on which the synced state config is being set
- * @param syncedStateId - The ID of the view state that this config schema is being set for
- * @param defaultValue - The default string that the SharedString will be initialized as
- */
-export function setSyncedStringConfig(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-    defaultValue: string,
-) {
-    syncedDataObject.setConfig<ISyncedStringState>(syncedStateId, {
-        syncedStateId,
-        fluidToView: new Map([
-            [
-                "value", {
-                    type: SharedString.name,
-                    viewKey: "value",
-                    sharedObjectCreate: (runtime) => {
-                        const url = SharedString.create(runtime);
-                        url.insertText(0, defaultValue);
-                        return url;
-                    },
-                },
-            ],
-        ]) as any,
-        defaultViewState: {},
-    });
-}
-
-/**
- * Function to use the SharedString state that has been prepared for this view
- * @param syncedDataObject - The Fluid data object that holds the synced state config for this view
- * @param syncedStateId - The ID of this view state
- * @returns [the initialized SharedString, a synced setState call for the SharedString]
- */
-export function useSyncedString(
-    syncedDataObject: SyncedDataObject,
-    syncedStateId: string,
-): [SharedString | undefined, (newState: ISyncedStringState) => void] {
-    const [state, setState] = useStateFluid<ISyncedStringState, ISyncedStringState>(
-        {
-            syncedDataObject,
-            syncedStateId,
-        }, {},
-    );
-    return [state.value, setState];
-}