@microsoft/live-share-react 1.0.0-preview.21 → 1.0.0-preview.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/bin/internal/errors.d.ts +26 -0
- package/bin/internal/errors.d.ts.map +1 -0
- package/bin/internal/errors.js +39 -0
- package/bin/internal/errors.js.map +1 -0
- package/bin/internal/index.d.ts +4 -0
- package/bin/internal/index.d.ts.map +1 -0
- package/bin/internal/index.js +4 -0
- package/bin/internal/index.js.map +1 -0
- package/bin/internal/type-guards.d.ts +6 -0
- package/bin/internal/type-guards.d.ts.map +1 -0
- package/bin/internal/type-guards.js +8 -0
- package/bin/internal/type-guards.js.map +1 -0
- package/bin/internal/useSharedStateRegistry.d.ts +31 -0
- package/bin/internal/useSharedStateRegistry.d.ts.map +1 -0
- package/bin/internal/useSharedStateRegistry.js +102 -0
- package/bin/internal/useSharedStateRegistry.js.map +1 -0
- package/bin/live-hooks/useLiveEvent.d.ts.map +1 -1
- package/bin/live-hooks/useLiveEvent.js +9 -3
- package/bin/live-hooks/useLiveEvent.js.map +1 -1
- package/bin/live-hooks/useLivePresence.d.ts +2 -2
- package/bin/live-hooks/useLivePresence.d.ts.map +1 -1
- package/bin/live-hooks/useLivePresence.js +14 -14
- package/bin/live-hooks/useLivePresence.js.map +1 -1
- package/bin/live-hooks/useLiveState.d.ts +2 -2
- package/bin/live-hooks/useLiveState.d.ts.map +1 -1
- package/bin/live-hooks/useLiveState.js +15 -8
- package/bin/live-hooks/useLiveState.js.map +1 -1
- package/bin/live-hooks/useLiveTimer.d.ts.map +1 -1
- package/bin/live-hooks/useLiveTimer.js +21 -15
- package/bin/live-hooks/useLiveTimer.js.map +1 -1
- package/bin/live-hooks/useMediaSynchronizer.d.ts.map +1 -1
- package/bin/live-hooks/useMediaSynchronizer.js +31 -12
- package/bin/live-hooks/useMediaSynchronizer.js.map +1 -1
- package/bin/providers/AzureProvider.d.ts +1 -1
- package/bin/providers/AzureProvider.d.ts.map +1 -1
- package/bin/providers/AzureProvider.js +1 -1
- package/bin/providers/AzureProvider.js.map +1 -1
- package/bin/providers/LiveShareProvider.js +1 -1
- package/bin/providers/LiveShareProvider.js.map +1 -1
- package/bin/shared-hooks/useSharedMap.d.ts.map +1 -1
- package/bin/shared-hooks/useSharedMap.js +15 -8
- package/bin/shared-hooks/useSharedMap.js.map +1 -1
- package/bin/shared-hooks/useSharedState.d.ts.map +1 -1
- package/bin/shared-hooks/useSharedState.js +9 -3
- package/bin/shared-hooks/useSharedState.js.map +1 -1
- package/bin/types/ActionTypes.d.ts +8 -2
- package/bin/types/ActionTypes.d.ts.map +1 -1
- package/package.json +8 -8
- package/src/internal/errors.ts +48 -0
- package/src/internal/index.ts +3 -0
- package/src/internal/type-guards.ts +9 -0
- package/src/live-hooks/useLiveEvent.ts +21 -5
- package/src/live-hooks/useLivePresence.ts +27 -21
- package/src/live-hooks/useLiveState.ts +31 -17
- package/src/live-hooks/useLiveTimer.ts +32 -26
- package/src/live-hooks/useMediaSynchronizer.ts +60 -8
- package/src/providers/AzureProvider.tsx +1 -1
- package/src/providers/LiveShareProvider.tsx +1 -1
- package/src/shared-hooks/useSharedMap.ts +29 -10
- package/src/shared-hooks/useSharedState.ts +9 -3
- package/src/types/ActionTypes.ts +10 -2
- package/src/internal-hooks/index.ts +0 -1
- /package/src/{internal-hooks → internal}/useSharedStateRegistry.ts +0 -0
package/README.md
CHANGED
|
@@ -584,7 +584,7 @@ The Live Share SDK contains dependencies for [@microsoft/teams-js](https://www.n
|
|
|
584
584
|
|
|
585
585
|
| @microsoft/live-share | @microsoft/teams-js | fluid-framework | @microsoft/live-share-\* | @fluidframework/azure-client | @microsoft/TeamsFx | @microsoft/TeamsFx-react |
|
|
586
586
|
| --------------------- | -------------------- | --------------- | -------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
|
|
587
|
-
| 1.0.0-preview.
|
|
587
|
+
| 1.0.0-preview.23 | ^2.11.0 | ^1.2.3 | 1.0.0-preview.23 (optional) | ^1.0.0 (optional) | ^2.5.0 (optional) | ^2.5.0 (optional) |
|
|
588
588
|
| 1.0.0-preview.10 | ^2.10.1 | ~1.2.3 | 1.0.0-preview.10 (optional) | ~1.0.2 (optional) | ^2.5.0 (optional) | ^2.5.0 (optional) |
|
|
589
589
|
| 1.0.0-preview.8 | ^2.5.0 | ~1.2.3 | 1.0.0-preview.10 (optional) | ~1.0.2 (optional) | ^2.5.0 (optional) | ^2.5.0 (optional) |
|
|
590
590
|
| 1.0.0-preview.3 | 2.0.0-experimental.1 | ~1.2.3 | 1.0.0-preview.3 (optional) | ~1.0.2 (optional) | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
*/
|
|
4
|
+
declare class UseLiveDataObjectActionError extends Error {
|
|
5
|
+
constructor(ddsName: string, functionName: string, message: string);
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @hidden
|
|
9
|
+
*/
|
|
10
|
+
export declare class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
|
|
11
|
+
constructor(ddsName: string, functionName: string);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @hidden
|
|
15
|
+
*/
|
|
16
|
+
export declare class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
|
|
17
|
+
constructor(ddsName: string, functionName: string);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @hidden
|
|
21
|
+
*/
|
|
22
|
+
export declare class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
|
|
23
|
+
constructor(ddsName: string, functionName: string);
|
|
24
|
+
}
|
|
25
|
+
export {};
|
|
26
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/internal/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAM,4BAA6B,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAKrE;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,4BAA4B;gBAC/D,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAGpD;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,4BAA4B;gBACpE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAOpD;AAED;;GAEG;AACH,qBAAa,oCAAqC,SAAQ,4BAA4B;gBACtE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAGpD"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
*/
|
|
4
|
+
class UseLiveDataObjectActionError extends Error {
|
|
5
|
+
constructor(ddsName, functionName, message) {
|
|
6
|
+
super(`use${toFirstLetterUppercase(ddsName)} ${functionName}: ${message}`);
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
*/
|
|
12
|
+
export class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
|
|
13
|
+
constructor(ddsName, functionName) {
|
|
14
|
+
super(ddsName, functionName, "container has not yet been joined");
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @hidden
|
|
19
|
+
*/
|
|
20
|
+
export class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
|
|
21
|
+
constructor(ddsName, functionName) {
|
|
22
|
+
super(ddsName, functionName, `${ddsName} is undefined, which means it is still being dynamically created`);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @hidden
|
|
27
|
+
*/
|
|
28
|
+
export class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
|
|
29
|
+
constructor(ddsName, functionName) {
|
|
30
|
+
super(ddsName, functionName, `${ddsName} is not initialized`);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* @hidden
|
|
35
|
+
*/
|
|
36
|
+
function toFirstLetterUppercase(word) {
|
|
37
|
+
return word[0].toUpperCase() + word.substring(1);
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=errors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/internal/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,4BAA6B,SAAQ,KAAK;IAC5C,YAAY,OAAe,EAAE,YAAoB,EAAE,OAAe;QAC9D,KAAK,CACD,MAAM,sBAAsB,CAAC,OAAO,CAAC,IAAI,YAAY,KAAK,OAAO,EAAE,CACtE,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,4BAA4B;IAC3E,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,mCAAmC,CAAC,CAAC;IACtE,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,kCAAmC,SAAQ,4BAA4B;IAChF,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CACD,OAAO,EACP,YAAY,EACZ,GAAG,OAAO,kEAAkE,CAC/E,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,4BAA4B;IAClF,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,qBAAqB,CAAC,CAAC;IAClE,CAAC;CACJ;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,IAAY;IACxC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EACtC,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAEpC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAC/B,KAAU;IAEV,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACvC,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
+
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
+
*/
|
|
5
|
+
import { DeleteSharedStateAction, IAzureContainerResults, RegisterSharedSetStateAction, UnregisterSharedSetStateAction, UpdateSharedStateAction } from "../types";
|
|
6
|
+
export interface ISharedStateRegistryResponse {
|
|
7
|
+
/**
|
|
8
|
+
* Register a set state action callback
|
|
9
|
+
*/
|
|
10
|
+
registerSharedSetStateAction: RegisterSharedSetStateAction;
|
|
11
|
+
/**
|
|
12
|
+
* Unregister a set state action callback
|
|
13
|
+
*/
|
|
14
|
+
unregisterSharedSetStateAction: UnregisterSharedSetStateAction;
|
|
15
|
+
/**
|
|
16
|
+
* Setter callback to update the shared state
|
|
17
|
+
*/
|
|
18
|
+
updateSharedState: UpdateSharedStateAction;
|
|
19
|
+
/**
|
|
20
|
+
* Delete a shared state value
|
|
21
|
+
*/
|
|
22
|
+
deleteSharedState: DeleteSharedStateAction;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Hook used internally to keep track of the SharedSetStateActionMap for each unique key. It sets state values for provided keys and updates components listening to the values.
|
|
26
|
+
*
|
|
27
|
+
* @param results IAzureContainerResults response or undefined
|
|
28
|
+
* @returns ISharedStateRegistryResponse object
|
|
29
|
+
*/
|
|
30
|
+
export declare const useSharedStateRegistry: (results: IAzureContainerResults | undefined) => ISharedStateRegistryResponse;
|
|
31
|
+
//# sourceMappingURL=useSharedStateRegistry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useSharedStateRegistry.d.ts","sourceRoot":"","sources":["../../src/internal/useSharedStateRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,EAE5B,8BAA8B,EAC9B,uBAAuB,EAC1B,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,4BAA4B,EAAE,4BAA4B,CAAC;IAC3D;;OAEG;IACH,8BAA8B,EAAE,8BAA8B,CAAC;IAC/D;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;CAC9C;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,YACtB,sBAAsB,GAAG,SAAS,KAC5C,4BAwHF,CAAC"}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
+
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
+
*/
|
|
5
|
+
import React from "react";
|
|
6
|
+
/**
|
|
7
|
+
* Hook used internally to keep track of the SharedSetStateActionMap for each unique key. It sets state values for provided keys and updates components listening to the values.
|
|
8
|
+
*
|
|
9
|
+
* @param results IAzureContainerResults response or undefined
|
|
10
|
+
* @returns ISharedStateRegistryResponse object
|
|
11
|
+
*/
|
|
12
|
+
export const useSharedStateRegistry = (results) => {
|
|
13
|
+
const registeredSharedSetStateActionMapRef = React.useRef(new Map());
|
|
14
|
+
/**
|
|
15
|
+
* @see ISharedStateRegistryResponse.registerSharedSetStateAction
|
|
16
|
+
*/
|
|
17
|
+
const registerSharedSetStateAction = React.useCallback((uniqueKey, componentId, setLocalStateAction) => {
|
|
18
|
+
let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
|
|
19
|
+
if (actionsMap) {
|
|
20
|
+
if (!actionsMap.has(componentId)) {
|
|
21
|
+
actionsMap.set(componentId, setLocalStateAction);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
else {
|
|
25
|
+
actionsMap = new Map();
|
|
26
|
+
actionsMap.set(componentId, setLocalStateAction);
|
|
27
|
+
registeredSharedSetStateActionMapRef.current.set(uniqueKey, actionsMap);
|
|
28
|
+
}
|
|
29
|
+
// Set initial values, if known
|
|
30
|
+
const stateMap = results === null || results === void 0 ? void 0 : results.container.initialObjects.TURBO_STATE_MAP;
|
|
31
|
+
const initialValue = stateMap === null || stateMap === void 0 ? void 0 : stateMap.get(uniqueKey);
|
|
32
|
+
if (initialValue) {
|
|
33
|
+
setLocalStateAction(initialValue);
|
|
34
|
+
}
|
|
35
|
+
}, [results]);
|
|
36
|
+
/**
|
|
37
|
+
* @see ISharedStateRegistryResponse.unregisterSharedSetStateAction
|
|
38
|
+
*/
|
|
39
|
+
const unregisterSharedSetStateAction = React.useCallback((uniqueKey, componentId) => {
|
|
40
|
+
let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
|
|
41
|
+
if (actionsMap === null || actionsMap === void 0 ? void 0 : actionsMap.has(componentId)) {
|
|
42
|
+
actionsMap.delete(componentId);
|
|
43
|
+
}
|
|
44
|
+
}, []);
|
|
45
|
+
/**
|
|
46
|
+
* @see ISharedStateRegistryResponse.updateSharedState
|
|
47
|
+
*/
|
|
48
|
+
const updateSharedState = React.useCallback((uniqueKey, value) => {
|
|
49
|
+
if (!results)
|
|
50
|
+
return;
|
|
51
|
+
const { container } = results;
|
|
52
|
+
const stateMap = container.initialObjects
|
|
53
|
+
.TURBO_STATE_MAP;
|
|
54
|
+
stateMap.set(uniqueKey, value);
|
|
55
|
+
}, [results]);
|
|
56
|
+
/**
|
|
57
|
+
* @see ISharedStateRegistryResponse.deleteSharedState
|
|
58
|
+
*/
|
|
59
|
+
const deleteSharedState = React.useCallback((uniqueKey) => {
|
|
60
|
+
if (!results)
|
|
61
|
+
return;
|
|
62
|
+
const { container } = results;
|
|
63
|
+
let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
|
|
64
|
+
actionsMap === null || actionsMap === void 0 ? void 0 : actionsMap.clear();
|
|
65
|
+
const stateMap = container.initialObjects
|
|
66
|
+
.TURBO_STATE_MAP;
|
|
67
|
+
stateMap.delete(uniqueKey);
|
|
68
|
+
}, [results]);
|
|
69
|
+
React.useEffect(() => {
|
|
70
|
+
if (!results)
|
|
71
|
+
return;
|
|
72
|
+
const { container } = results;
|
|
73
|
+
const stateMap = container.initialObjects.TURBO_STATE_MAP;
|
|
74
|
+
const valueChangedListener = (changed) => {
|
|
75
|
+
if (registeredSharedSetStateActionMapRef.current.has(changed.key)) {
|
|
76
|
+
const value = stateMap.get(changed.key);
|
|
77
|
+
const actionMap = registeredSharedSetStateActionMapRef.current.get(changed.key);
|
|
78
|
+
actionMap === null || actionMap === void 0 ? void 0 : actionMap.forEach((setLocalStateHandler) => {
|
|
79
|
+
setLocalStateHandler(value);
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
stateMap.on("valueChanged", valueChangedListener);
|
|
84
|
+
// Set initial values
|
|
85
|
+
stateMap.forEach((value, key) => {
|
|
86
|
+
const actionMap = registeredSharedSetStateActionMapRef.current.get(key);
|
|
87
|
+
actionMap === null || actionMap === void 0 ? void 0 : actionMap.forEach((setLocalStateHandler) => {
|
|
88
|
+
setLocalStateHandler(value);
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
return () => {
|
|
92
|
+
stateMap.off("valueChanged", valueChangedListener);
|
|
93
|
+
};
|
|
94
|
+
}, [results]);
|
|
95
|
+
return {
|
|
96
|
+
registerSharedSetStateAction,
|
|
97
|
+
unregisterSharedSetStateAction,
|
|
98
|
+
updateSharedState,
|
|
99
|
+
deleteSharedState,
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
//# sourceMappingURL=useSharedStateRegistry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useSharedStateRegistry.js","sourceRoot":"","sources":["../../src/internal/useSharedStateRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,MAAM,OAAO,CAAC;AA6B1B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAClC,OAA2C,EACf,EAAE;IAC9B,MAAM,oCAAoC,GAAG,KAAK,CAAC,MAAM,CAEvD,IAAI,GAAG,EAAE,CAAC,CAAC;IAEb;;OAEG;IACH,MAAM,4BAA4B,GAAG,KAAK,CAAC,WAAW,CAClD,CACI,SAAiB,EACjB,WAAmB,EACnB,mBAAwC,EAC1C,EAAE;QACA,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;gBAC9B,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;aACpD;SACJ;aAAM;YACH,UAAU,GAAG,IAAI,GAAG,EAA+B,CAAC;YACpD,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACjD,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAC5C,SAAS,EACT,UAAU,CACb,CAAC;SACL;QACD,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC,cAAc,CAC7C,eAAwC,CAAC;QAC9C,MAAM,YAAY,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,YAAY,EAAE;YACd,mBAAmB,CAAC,YAAY,CAAC,CAAC;SACrC;IACL,CAAC,EACD,CAAC,OAAO,CAAC,CACZ,CAAC;IAEF;;OAEG;IACH,MAAM,8BAA8B,GAAG,KAAK,CAAC,WAAW,CACpD,CAAC,SAAiB,EAAE,WAAmB,EAAE,EAAE;QACvC,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,CAAC,WAAW,CAAC,EAAE;YAC9B,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAClC;IACL,CAAC,EACD,EAAE,CACL,CAAC;IAEF;;OAEG;IACH,MAAM,iBAAiB,GAA4B,KAAK,CAAC,WAAW,CAChE,CAAC,SAAiB,EAAE,KAAU,EAAE,EAAE;QAC9B,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc;aACpC,eAA4B,CAAC;QAClC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC,EACD,CAAC,OAAO,CAAC,CACZ,CAAC;IAEF;;OAEG;IACH,MAAM,iBAAiB,GAA4B,KAAK,CAAC,WAAW,CAChE,CAAC,SAAiB,EAAE,EAAE;QAClB,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc;aACpC,eAA4B,CAAC;QAClC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC,EACD,CAAC,OAAO,CAAC,CACZ,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC,eAA4B,CAAC;QACvE,MAAM,oBAAoB,GAAG,CAAC,OAAsB,EAAQ,EAAE;YAC1D,IAAI,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACxC,MAAM,SAAS,GACX,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAC5C,OAAO,CAAC,GAAG,CACd,CAAC;gBACN,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE;oBACxC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QACF,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QAClD,qBAAqB;QACrB,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,GAAW,EAAE,EAAE;YACzC,MAAM,SAAS,GACX,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1D,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE;gBACxC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACR,QAAQ,CAAC,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QACvD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO;QACH,4BAA4B;QAC5B,8BAA8B;QAC9B,iBAAiB;QACjB,iBAAiB;KACpB,CAAC;AACN,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveEvent.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAElB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EACpB,yBAAyB,EAE5B,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"useLiveEvent.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAElB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EACpB,yBAAyB,EAE5B,MAAM,UAAU,CAAC;AAUlB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,MAAM,GAAG,GAAG,EACrC,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,eAAe,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC,GACpD,oBAAoB,CAAC,MAAM,CAAC,CAqF9B"}
|
|
@@ -14,6 +14,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
14
14
|
import { LiveEventEvents, LiveEvent, } from "@microsoft/live-share";
|
|
15
15
|
import React from "react";
|
|
16
16
|
import { useDynamicDDS } from "../shared-hooks";
|
|
17
|
+
import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, } from "../internal";
|
|
18
|
+
import { useFluidObjectsContext } from "../providers";
|
|
17
19
|
/**
|
|
18
20
|
* React hook for using a Live Share `LiveEvent`.
|
|
19
21
|
*
|
|
@@ -42,18 +44,22 @@ export function useLiveEvent(uniqueKey, allowedRoles, onReceivedEvent) {
|
|
|
42
44
|
* User facing: dynamically load the DDS for the given unique key.
|
|
43
45
|
*/
|
|
44
46
|
const { dds: liveEvent } = useDynamicDDS(uniqueKey, (LiveEvent));
|
|
47
|
+
const { container } = useFluidObjectsContext();
|
|
45
48
|
/**
|
|
46
49
|
* User facing: callback to send event through `LiveEvent`
|
|
47
50
|
*/
|
|
48
51
|
const sendEvent = React.useCallback((event) => __awaiter(this, void 0, void 0, function* () {
|
|
52
|
+
if (!container) {
|
|
53
|
+
throw new ActionContainerNotJoinedError("liveEvent", "sendEvent");
|
|
54
|
+
}
|
|
49
55
|
if (liveEvent === undefined) {
|
|
50
|
-
throw new
|
|
56
|
+
throw new ActionLiveDataObjectUndefinedError("liveEvent", "sendEvent");
|
|
51
57
|
}
|
|
52
58
|
if (!liveEvent.isInitialized) {
|
|
53
|
-
throw new
|
|
59
|
+
throw new ActionLiveDataObjectInitializedError("liveEvent", "sendEvent");
|
|
54
60
|
}
|
|
55
61
|
return yield liveEvent.send(event);
|
|
56
|
-
}), [liveEvent]);
|
|
62
|
+
}), [container, liveEvent]);
|
|
57
63
|
/**
|
|
58
64
|
* Setup change listeners and start `LiveEvent` if needed
|
|
59
65
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveEvent.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EACH,eAAe,EAEf,SAAS,GACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"useLiveEvent.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EACH,eAAe,EAEf,SAAS,GACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACH,6BAA6B,EAC7B,oCAAoC,EACpC,kCAAkC,GACrC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEtD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,YAAY,CACxB,SAAiB,EACjB,YAAgC,EAChC,eAAmD;IAEnD;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,iBAAiB,CAAC,GAClC,KAAK,CAAC,QAAQ,EAA6B,CAAC;IAChD;;;OAGG;IACH,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAA8B,EAAE,CAAC,CAAC;IACnE;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,aAAa,CACpC,SAAS,EACT,CAAA,SAAiB,CAAA,CACpB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,SAAS,GAAgC,KAAK,CAAC,WAAW,CAC5D,CAAO,KAAa,EAAE,EAAE;QACpB,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,WAAW,EACX,WAAW,CACd,CAAC;SACL;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CACxC,WAAW,EACX,WAAW,CACd,CAAC;SACL;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAC1C,WAAW,EACX,WAAW,CACd,CAAC;SACL;QACD,OAAO,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,aAAa,MAAK,SAAS;YAAE,OAAO;QACnD,0BAA0B;QAC1B,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,KAAc,EAAE,EAAE;YACtD,gEAAgE;YAChE,WAAW;YACX,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAG,KAAK,EAAE,KAAK,CAAC,CAAC;YAChC,4CAA4C;YAC5C,MAAM,QAAQ,GAA8B;gBACxC,KAAK,EAAE,KAAK;gBACZ,KAAK;aACR,CAAC;YACF,YAAY,CAAC,OAAO,GAAG,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC3D,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,mBAAmB;YACnB,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;SACtC;QAED,OAAO,GAAG,EAAE;YACR,qCAAqC;YACrC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QAC9D,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO;QACH,WAAW;QACX,SAAS,EAAE,YAAY,CAAC,OAAO;QAC/B,SAAS;QACT,SAAS;KACZ,CAAC;AACN,CAAC"}
|
|
@@ -15,12 +15,12 @@ import { IUseLivePresenceResults } from "../types";
|
|
|
15
15
|
* @template TData Optional typing for the custom user presence data object. Default is `object` type.
|
|
16
16
|
* @param uniqueKey The unique key for `LivePresence`. If one does not yet exist, a new one
|
|
17
17
|
* @param userId Optional. The unique ID for a user. If none is provided, a random UUID will be generated.
|
|
18
|
-
* @param initialData Optional. Initial presence data object for the user.
|
|
18
|
+
* @param initialData Optional. Initial presence data object for the user. Can be value or a function to get the value.
|
|
19
19
|
* @param initialPresenceState Optional. Initial status of the user's presence. Default is online.
|
|
20
20
|
* @param allowedRoles Optional. the user roles that are allowed to mutate the synchronized state
|
|
21
21
|
* will be created, otherwise it will use the existing one. Default value is ":<dds-default>"
|
|
22
22
|
* @returns stateful `localUser`, `otherUsers` list, and `allUsers` list. Also returns a callback method
|
|
23
23
|
* to update the local user's presence and the `LivePresence` Fluid object.
|
|
24
24
|
*/
|
|
25
|
-
export declare function useLivePresence<TData extends object = object>(uniqueKey: string, initialData?: TData | undefined, initialPresenceState?: PresenceState, allowedRoles?: UserMeetingRole[]): IUseLivePresenceResults<TData>;
|
|
25
|
+
export declare function useLivePresence<TData extends object = object>(uniqueKey: string, initialData?: TData | (() => TData) | undefined, initialPresenceState?: PresenceState, allowedRoles?: UserMeetingRole[]): IUseLivePresenceResults<TData>;
|
|
26
26
|
//# sourceMappingURL=useLivePresence.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLivePresence.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLivePresence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,aAAa,EAEb,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,uBAAuB,EAA8B,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"useLivePresence.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLivePresence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,aAAa,EAEb,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,uBAAuB,EAA8B,MAAM,UAAU,CAAC;AAS/E;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EACzD,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,SAAS,EAC/C,oBAAoB,GAAE,aAAoC,EAC1D,YAAY,CAAC,EAAE,eAAe,EAAE,GACjC,uBAAuB,CAAC,KAAK,CAAC,CA4FhC"}
|
|
@@ -14,6 +14,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
14
14
|
import { PresenceState, LivePresence, } from "@microsoft/live-share";
|
|
15
15
|
import React from "react";
|
|
16
16
|
import { useDynamicDDS } from "../shared-hooks";
|
|
17
|
+
import { useFluidObjectsContext } from "../providers";
|
|
18
|
+
import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, } from "../internal";
|
|
17
19
|
/**
|
|
18
20
|
* React hook for using a Live Share `LivePresence`.
|
|
19
21
|
*
|
|
@@ -25,7 +27,7 @@ import { useDynamicDDS } from "../shared-hooks";
|
|
|
25
27
|
* @template TData Optional typing for the custom user presence data object. Default is `object` type.
|
|
26
28
|
* @param uniqueKey The unique key for `LivePresence`. If one does not yet exist, a new one
|
|
27
29
|
* @param userId Optional. The unique ID for a user. If none is provided, a random UUID will be generated.
|
|
28
|
-
* @param initialData Optional. Initial presence data object for the user.
|
|
30
|
+
* @param initialData Optional. Initial presence data object for the user. Can be value or a function to get the value.
|
|
29
31
|
* @param initialPresenceState Optional. Initial status of the user's presence. Default is online.
|
|
30
32
|
* @param allowedRoles Optional. the user roles that are allowed to mutate the synchronized state
|
|
31
33
|
* will be created, otherwise it will use the existing one. Default value is ":<dds-default>"
|
|
@@ -44,29 +46,27 @@ export function useLivePresence(uniqueKey, initialData, initialPresenceState = P
|
|
|
44
46
|
/**
|
|
45
47
|
* User facing: list of non-local user's presence objects.
|
|
46
48
|
*/
|
|
47
|
-
const otherUsers =
|
|
48
|
-
return [...allUsers.filter((user) => !user.isLocalUser)];
|
|
49
|
-
}, [allUsers]);
|
|
49
|
+
const otherUsers = allUsers.filter((user) => !user.isLocalUser);
|
|
50
50
|
/**
|
|
51
51
|
* User facing: local user's presence object.
|
|
52
52
|
*/
|
|
53
|
-
const localUser =
|
|
54
|
-
|
|
55
|
-
}, [allUsers]);
|
|
53
|
+
const localUser = allUsers.find((user) => user.isLocalUser);
|
|
54
|
+
const { container } = useFluidObjectsContext();
|
|
56
55
|
/**
|
|
57
56
|
* User facing: callback to update the local user's presence.
|
|
58
57
|
*/
|
|
59
58
|
const updatePresence = React.useCallback((data, state) => __awaiter(this, void 0, void 0, function* () {
|
|
60
|
-
if (!
|
|
61
|
-
|
|
62
|
-
|
|
59
|
+
if (!container) {
|
|
60
|
+
throw new ActionContainerNotJoinedError("livePresence", "updatePresence");
|
|
61
|
+
}
|
|
62
|
+
if (livePresence === undefined) {
|
|
63
|
+
throw new ActionLiveDataObjectUndefinedError("livePresence", "updatePresence");
|
|
63
64
|
}
|
|
64
65
|
if (!livePresence.isInitialized) {
|
|
65
|
-
|
|
66
|
-
return;
|
|
66
|
+
throw new ActionLiveDataObjectInitializedError("livePresence", "updatePresence");
|
|
67
67
|
}
|
|
68
68
|
return yield livePresence.update(data, state);
|
|
69
|
-
}), [livePresence]);
|
|
69
|
+
}), [container, livePresence]);
|
|
70
70
|
/**
|
|
71
71
|
* Setup change listeners and start `LivePresence` if needed
|
|
72
72
|
*/
|
|
@@ -82,7 +82,7 @@ export function useLivePresence(uniqueKey, initialData, initialPresenceState = P
|
|
|
82
82
|
};
|
|
83
83
|
livePresence.on("presenceChanged", onPresenceChanged);
|
|
84
84
|
if (!livePresence.isInitialized) {
|
|
85
|
-
livePresence.initialize(initialData, initialPresenceState, allowedRoles);
|
|
85
|
+
livePresence.initialize(typeof initialData === "function" ? initialData() : initialData, initialPresenceState, allowedRoles);
|
|
86
86
|
}
|
|
87
87
|
else {
|
|
88
88
|
onPresenceChanged();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLivePresence.js","sourceRoot":"","sources":["../../src/live-hooks/useLivePresence.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAEH,aAAa,EACb,YAAY,GAEf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"useLivePresence.js","sourceRoot":"","sources":["../../src/live-hooks/useLivePresence.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAEH,aAAa,EACb,YAAY,GAEf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACH,6BAA6B,EAC7B,oCAAoC,EACpC,kCAAkC,GACrC,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,eAAe,CAC3B,SAAiB,EACjB,WAA+C,EAC/C,uBAAsC,aAAa,CAAC,MAAM,EAC1D,YAAgC;IAEhC;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1C,EAAE,CACL,CAAC;IACF;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,aAAa,CACvC,SAAS,EACT,CAAA,YAAmB,CAAA,CACtB,CAAC;IAEF;;OAEG;IACH,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEhE;;OAEG;IACH,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAE5D,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,cAAc,GAAsC,KAAK,CAAC,WAAW,CACvE,CAAO,IAAwB,EAAE,KAAiC,EAAE,EAAE;QAClE,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,cAAc,EACd,gBAAgB,CACnB,CAAC;SACL;QACD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC5B,MAAM,IAAI,kCAAkC,CACxC,cAAc,EACd,gBAAgB,CACnB,CAAC;SACL;QACD,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE;YAC7B,MAAM,IAAI,oCAAoC,CAC1C,cAAc,EACd,gBAAgB,CACnB,CAAC;SACL;QACD,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,YAAY,CAAC,CAC5B,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,YAAY,KAAK,SAAS;YAAE,OAAO;QAEvC,MAAM,iBAAiB,GAAG,GAAG,EAAE;YAC3B,MAAM,iBAAiB,GAA8B,EAAE,CAAC;YACxD,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACtC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACnC,CAAC,CAAC;QACF,YAAY,CAAC,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QAEtD,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE;YAC7B,YAAY,CAAC,UAAU,CACnB,OAAO,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,EAC/D,oBAAoB,EACpB,YAAY,CACf,CAAC;SACL;aAAM;YACH,iBAAiB,EAAE,CAAC;SACvB;QAED,OAAO,GAAG,EAAE;YACR,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,GAAG,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QAC5D,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,OAAO;QACH,SAAS;QACT,UAAU;QACV,QAAQ;QACR,YAAY;QACZ,cAAc;KACjB,CAAC;AACN,CAAC"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
3
|
* Licensed under the Microsoft Live Share SDK License.
|
|
4
4
|
*/
|
|
5
|
-
import { UserMeetingRole } from "@microsoft/live-share";
|
|
5
|
+
import { LiveState, UserMeetingRole } from "@microsoft/live-share";
|
|
6
6
|
import { SetLiveStateAction } from "../types";
|
|
7
7
|
/**
|
|
8
8
|
* React hook for using a Live Share `LiveState`.
|
|
@@ -16,5 +16,5 @@ import { SetLiveStateAction } from "../types";
|
|
|
16
16
|
* @returns ordered values: first value is the synchronized state value and the second is a setter to change the state value.
|
|
17
17
|
* The setter returns a void promise, which will throw if the user does not have the required roles to set.
|
|
18
18
|
*/
|
|
19
|
-
export declare function useLiveState<TState
|
|
19
|
+
export declare function useLiveState<TState>(uniqueKey: string, initialState: TState, allowedRoles?: UserMeetingRole[]): [TState, SetLiveStateAction<TState>, LiveState<TState> | undefined];
|
|
20
20
|
//# sourceMappingURL=useLiveState.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveState.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"useLiveState.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAU9C;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAC/B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,eAAe,EAAE,GACjC,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAqErE"}
|
|
@@ -14,6 +14,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
14
14
|
import { LiveState } from "@microsoft/live-share";
|
|
15
15
|
import React from "react";
|
|
16
16
|
import { useDynamicDDS } from "../shared-hooks";
|
|
17
|
+
import { useFluidObjectsContext } from "../providers";
|
|
18
|
+
import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, isPrevStateCallback, } from "../internal";
|
|
17
19
|
/**
|
|
18
20
|
* React hook for using a Live Share `LiveState`.
|
|
19
21
|
*
|
|
@@ -32,22 +34,27 @@ export function useLiveState(uniqueKey, initialState, allowedRoles) {
|
|
|
32
34
|
* User facing: dynamically load the DDS for the given unique key.
|
|
33
35
|
*/
|
|
34
36
|
const { dds: liveState } = useDynamicDDS(uniqueKey, (LiveState));
|
|
37
|
+
const { container } = useFluidObjectsContext();
|
|
35
38
|
/**
|
|
36
39
|
* Change state callback that is user facing
|
|
37
40
|
* @param state TState to set
|
|
38
41
|
* @returns void promise, which will throw if the user does not have the required roles
|
|
39
42
|
*/
|
|
40
43
|
const setState = React.useCallback((state) => __awaiter(this, void 0, void 0, function* () {
|
|
41
|
-
if (!
|
|
42
|
-
|
|
43
|
-
|
|
44
|
+
if (!container) {
|
|
45
|
+
throw new ActionContainerNotJoinedError("liveState", "setState");
|
|
46
|
+
}
|
|
47
|
+
if (liveState === undefined) {
|
|
48
|
+
throw new ActionLiveDataObjectUndefinedError("liveState", "setState");
|
|
44
49
|
}
|
|
45
50
|
if (!liveState.isInitialized) {
|
|
46
|
-
|
|
47
|
-
return;
|
|
51
|
+
throw new ActionLiveDataObjectInitializedError("liveState", "setState");
|
|
48
52
|
}
|
|
49
|
-
|
|
50
|
-
|
|
53
|
+
const valueToSet = isPrevStateCallback(state)
|
|
54
|
+
? state(liveState.state)
|
|
55
|
+
: state;
|
|
56
|
+
return yield liveState.set(valueToSet);
|
|
57
|
+
}), [container, liveState]);
|
|
51
58
|
/**
|
|
52
59
|
* Setup change listeners and start `LiveState` if needed
|
|
53
60
|
*/
|
|
@@ -68,6 +75,6 @@ export function useLiveState(uniqueKey, initialState, allowedRoles) {
|
|
|
68
75
|
liveState === null || liveState === void 0 ? void 0 : liveState.off("stateChanged", onStateChanged);
|
|
69
76
|
};
|
|
70
77
|
}, [liveState]);
|
|
71
|
-
return [currentState, setState];
|
|
78
|
+
return [currentState, setState, liveState];
|
|
72
79
|
}
|
|
73
80
|
//# sourceMappingURL=useLiveState.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveState.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveState.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAAE,SAAS,EAAmB,MAAM,uBAAuB,CAAC;AACnE,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"useLiveState.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveState.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAAE,SAAS,EAAmB,MAAM,uBAAuB,CAAC;AACnE,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACH,6BAA6B,EAC7B,oCAAoC,EACpC,kCAAkC,EAClC,mBAAmB,GACtB,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CACxB,SAAiB,EACjB,YAAoB,EACpB,YAAgC;IAEhC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GACjC,KAAK,CAAC,QAAQ,CAAS,YAAY,CAAC,CAAC;IACzC;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,aAAa,CACpC,SAAS,EACT,CAAA,SAAiB,CAAA,CACpB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;;;OAIG;IACH,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,CAAO,KAA+C,EAAE,EAAE;QACtD,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,WAAW,EACX,UAAU,CACb,CAAC;SACL;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CACxC,WAAW,EACX,UAAU,CACb,CAAC;SACL;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAC1C,WAAW,EACX,UAAU,CACb,CAAC;SACL;QACD,MAAM,UAAU,GAAG,mBAAmB,CAAS,KAAK,CAAC;YACjD,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC;YACxB,CAAC,CAAC,KAAK,CAAC;QACZ,OAAO,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO;QAEpC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,EAAE;YACrC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;SACpD;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE;YAClE,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SACnC;QAED,OAAO,GAAG,EAAE;YACR,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QACnD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC/C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveTimer.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,eAAe,EAElB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EAIpB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"useLiveTimer.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,eAAe,EAElB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EAIpB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,UAAU,CAAC;AASlB,wBAAgB,YAAY,CACxB,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,qBAAqB,EAC/B,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,oBAAoB,EAC7B,QAAQ,CAAC,EAAE,sBAAsB,GAClC,oBAAoB,CAwJtB"}
|
|
@@ -14,6 +14,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
14
14
|
import { LiveTimerEvents, LiveTimer, } from "@microsoft/live-share";
|
|
15
15
|
import React from "react";
|
|
16
16
|
import { useDynamicDDS } from "../shared-hooks";
|
|
17
|
+
import { useFluidObjectsContext } from "../providers";
|
|
18
|
+
import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, } from "../internal";
|
|
17
19
|
export function useLiveTimer(uniqueKey, allowedRoles, tickRate, onTick, onStart, onPause, onPlay, onFinish) {
|
|
18
20
|
/**
|
|
19
21
|
* User facing: Stateful timer config.
|
|
@@ -27,52 +29,56 @@ export function useLiveTimer(uniqueKey, allowedRoles, tickRate, onTick, onStart,
|
|
|
27
29
|
* User facing: dynamically load the DDS for the given unique key.
|
|
28
30
|
*/
|
|
29
31
|
const { dds: liveTimer } = useDynamicDDS(uniqueKey, LiveTimer);
|
|
32
|
+
const { container } = useFluidObjectsContext();
|
|
30
33
|
/**
|
|
31
34
|
* Callback to send event through `LiveTimer`
|
|
32
35
|
* @param duration the duration for the timer in milliseconds
|
|
33
36
|
* @returns void promise that will throw when user does not have required roles
|
|
34
37
|
*/
|
|
35
38
|
const start = React.useCallback((duration) => __awaiter(this, void 0, void 0, function* () {
|
|
39
|
+
if (!container) {
|
|
40
|
+
throw new ActionContainerNotJoinedError("liveTimer", "start");
|
|
41
|
+
}
|
|
36
42
|
if (liveTimer === undefined) {
|
|
37
|
-
|
|
38
|
-
return;
|
|
43
|
+
throw new ActionLiveDataObjectUndefinedError("liveTimer", "start");
|
|
39
44
|
}
|
|
40
45
|
if (!liveTimer.isInitialized) {
|
|
41
|
-
|
|
42
|
-
return;
|
|
46
|
+
throw new ActionLiveDataObjectInitializedError("liveTimer", "start");
|
|
43
47
|
}
|
|
44
48
|
return yield liveTimer.start(duration);
|
|
45
|
-
}), [liveTimer]);
|
|
49
|
+
}), [container, liveTimer]);
|
|
46
50
|
/**
|
|
47
51
|
* Callback to send event through `LiveTimer`
|
|
48
52
|
* @returns void promise that will throw when user does not have required roles
|
|
49
53
|
*/
|
|
50
54
|
const play = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
|
|
55
|
+
if (!container) {
|
|
56
|
+
throw new ActionContainerNotJoinedError("liveTimer", "play");
|
|
57
|
+
}
|
|
51
58
|
if (liveTimer === undefined) {
|
|
52
|
-
|
|
53
|
-
return;
|
|
59
|
+
throw new ActionLiveDataObjectUndefinedError("liveTimer", "play");
|
|
54
60
|
}
|
|
55
61
|
if (!liveTimer.isInitialized) {
|
|
56
|
-
|
|
57
|
-
return;
|
|
62
|
+
throw new ActionLiveDataObjectInitializedError("liveTimer", "play");
|
|
58
63
|
}
|
|
59
64
|
return yield liveTimer.play();
|
|
60
|
-
}), [liveTimer]);
|
|
65
|
+
}), [container, liveTimer]);
|
|
61
66
|
/**
|
|
62
67
|
* Callback to send event through `LiveTimer`
|
|
63
68
|
* @returns void promise that will throw when user does not have required roles
|
|
64
69
|
*/
|
|
65
70
|
const pause = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
|
|
71
|
+
if (!container) {
|
|
72
|
+
throw new ActionContainerNotJoinedError("liveTimer", "pause");
|
|
73
|
+
}
|
|
66
74
|
if (liveTimer === undefined) {
|
|
67
|
-
|
|
68
|
-
return;
|
|
75
|
+
throw new ActionLiveDataObjectUndefinedError("liveTimer", "pause");
|
|
69
76
|
}
|
|
70
77
|
if (!liveTimer.isInitialized) {
|
|
71
|
-
|
|
72
|
-
return;
|
|
78
|
+
throw new ActionLiveDataObjectInitializedError("liveTimer", "pause");
|
|
73
79
|
}
|
|
74
80
|
return yield liveTimer.pause();
|
|
75
|
-
}), [liveTimer]);
|
|
81
|
+
}), [container, liveTimer]);
|
|
76
82
|
/**
|
|
77
83
|
* Setup change listeners and start `LiveTimer` if needed
|
|
78
84
|
*/
|