@microsoft/live-share-react 2.0.0-internal.18 → 2.0.0-internal.19

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.
Files changed (289) hide show
  1. package/README.md +6 -0
  2. package/bin/esm/live-hooks/useLiveCanvas.js +29 -30
  3. package/bin/esm/live-hooks/useLiveCanvas.js.map +1 -1
  4. package/bin/esm/live-hooks/useLiveEvent.js +6 -15
  5. package/bin/esm/live-hooks/useLiveEvent.js.map +1 -1
  6. package/bin/esm/live-hooks/useLiveFollowMode.js +25 -34
  7. package/bin/esm/live-hooks/useLiveFollowMode.js.map +1 -1
  8. package/bin/esm/live-hooks/useLivePresence.js +5 -14
  9. package/bin/esm/live-hooks/useLivePresence.js.map +1 -1
  10. package/bin/esm/live-hooks/useLiveState.js +4 -13
  11. package/bin/esm/live-hooks/useLiveState.js.map +1 -1
  12. package/bin/esm/live-hooks/useLiveTimer.js +22 -31
  13. package/bin/esm/live-hooks/useLiveTimer.js.map +1 -1
  14. package/bin/esm/live-hooks/useMediaSynchronizer.js +24 -33
  15. package/bin/esm/live-hooks/useMediaSynchronizer.js.map +1 -1
  16. package/bin/esm/providers/AzureProvider.js +22 -27
  17. package/bin/esm/providers/AzureProvider.js.map +1 -1
  18. package/bin/esm/providers/LiveShareProvider.js +20 -21
  19. package/bin/esm/providers/LiveShareProvider.js.map +1 -1
  20. package/bin/esm/shared-hooks/internals/tree-node-types.js +1 -1
  21. package/bin/esm/shared-hooks/internals/tree-node-types.js.map +1 -1
  22. package/bin/esm/shared-hooks/internals/tree-node-utils.js +2 -4
  23. package/bin/esm/shared-hooks/internals/tree-node-utils.js.map +1 -1
  24. package/bin/esm/shared-hooks/useDynamicDDS.js +3 -12
  25. package/bin/esm/shared-hooks/useDynamicDDS.js.map +1 -1
  26. package/bin/esm/shared-hooks/useSharedMap.js +1 -1
  27. package/bin/esm/shared-hooks/useSharedMap.js.map +1 -1
  28. package/bin/esm/shared-hooks/useSharedStateRegistry.js +13 -10
  29. package/bin/esm/shared-hooks/useSharedStateRegistry.js.map +1 -1
  30. package/bin/esm/shared-hooks/useSharedTree.js +4 -4
  31. package/bin/esm/shared-hooks/useSharedTree.js.map +1 -1
  32. package/bin/esm/types/FluidMap.d.ts +151 -0
  33. package/bin/esm/types/FluidMap.d.ts.map +1 -0
  34. package/bin/esm/types/FluidMap.js +24 -0
  35. package/bin/esm/types/FluidMap.js.map +1 -0
  36. package/bin/esm/types/ResultTypes.d.ts +15 -1
  37. package/bin/esm/types/ResultTypes.d.ts.map +1 -1
  38. package/bin/esm/utils/type-check.js +1 -1
  39. package/bin/esm/utils/type-check.js.map +1 -1
  40. package/package.json +11 -21
  41. package/src/types/FluidMap.ts +169 -0
  42. package/src/types/ResultTypes.ts +18 -1
  43. package/tsconfig.json +3 -4
  44. package/bin/cjs/index.d.ts +0 -7
  45. package/bin/cjs/index.d.ts.map +0 -1
  46. package/bin/cjs/index.js +0 -23
  47. package/bin/cjs/index.js.map +0 -1
  48. package/bin/cjs/interfaces/LiveInterfaceExtensions.d.ts +0 -26
  49. package/bin/cjs/interfaces/LiveInterfaceExtensions.d.ts.map +0 -1
  50. package/bin/cjs/interfaces/LiveInterfaceExtensions.js +0 -7
  51. package/bin/cjs/interfaces/LiveInterfaceExtensions.js.map +0 -1
  52. package/bin/cjs/interfaces/index.d.ts +0 -2
  53. package/bin/cjs/interfaces/index.d.ts.map +0 -1
  54. package/bin/cjs/interfaces/index.js +0 -18
  55. package/bin/cjs/interfaces/index.js.map +0 -1
  56. package/bin/cjs/internal/errors.d.ts +0 -41
  57. package/bin/cjs/internal/errors.d.ts.map +0 -1
  58. package/bin/cjs/internal/errors.js +0 -48
  59. package/bin/cjs/internal/errors.js.map +0 -1
  60. package/bin/cjs/internal/index.d.ts +0 -3
  61. package/bin/cjs/internal/index.d.ts.map +0 -1
  62. package/bin/cjs/internal/index.js +0 -19
  63. package/bin/cjs/internal/index.js.map +0 -1
  64. package/bin/cjs/internal/type-guards.d.ts +0 -11
  65. package/bin/cjs/internal/type-guards.d.ts.map +0 -1
  66. package/bin/cjs/internal/type-guards.js +0 -24
  67. package/bin/cjs/internal/type-guards.js.map +0 -1
  68. package/bin/cjs/live-hooks/index.d.ts +0 -8
  69. package/bin/cjs/live-hooks/index.d.ts.map +0 -1
  70. package/bin/cjs/live-hooks/index.js +0 -24
  71. package/bin/cjs/live-hooks/index.js.map +0 -1
  72. package/bin/cjs/live-hooks/useLiveCanvas.d.ts +0 -80
  73. package/bin/cjs/live-hooks/useLiveCanvas.d.ts.map +0 -1
  74. package/bin/cjs/live-hooks/useLiveCanvas.js +0 -244
  75. package/bin/cjs/live-hooks/useLiveCanvas.js.map +0 -1
  76. package/bin/cjs/live-hooks/useLiveEvent.d.ts +0 -59
  77. package/bin/cjs/live-hooks/useLiveEvent.d.ts.map +0 -1
  78. package/bin/cjs/live-hooks/useLiveEvent.js +0 -150
  79. package/bin/cjs/live-hooks/useLiveEvent.js.map +0 -1
  80. package/bin/cjs/live-hooks/useLiveFollowMode.d.ts +0 -163
  81. package/bin/cjs/live-hooks/useLiveFollowMode.d.ts.map +0 -1
  82. package/bin/cjs/live-hooks/useLiveFollowMode.js +0 -360
  83. package/bin/cjs/live-hooks/useLiveFollowMode.js.map +0 -1
  84. package/bin/cjs/live-hooks/useLivePresence.d.ts +0 -76
  85. package/bin/cjs/live-hooks/useLivePresence.d.ts.map +0 -1
  86. package/bin/cjs/live-hooks/useLivePresence.js +0 -170
  87. package/bin/cjs/live-hooks/useLivePresence.js.map +0 -1
  88. package/bin/cjs/live-hooks/useLiveState.d.ts +0 -66
  89. package/bin/cjs/live-hooks/useLiveState.d.ts.map +0 -1
  90. package/bin/cjs/live-hooks/useLiveState.js +0 -134
  91. package/bin/cjs/live-hooks/useLiveState.js.map +0 -1
  92. package/bin/cjs/live-hooks/useLiveTimer.d.ts +0 -80
  93. package/bin/cjs/live-hooks/useLiveTimer.d.ts.map +0 -1
  94. package/bin/cjs/live-hooks/useLiveTimer.js +0 -233
  95. package/bin/cjs/live-hooks/useLiveTimer.js.map +0 -1
  96. package/bin/cjs/live-hooks/useMediaSynchronizer.d.ts +0 -86
  97. package/bin/cjs/live-hooks/useMediaSynchronizer.d.ts.map +0 -1
  98. package/bin/cjs/live-hooks/useMediaSynchronizer.js +0 -301
  99. package/bin/cjs/live-hooks/useMediaSynchronizer.js.map +0 -1
  100. package/bin/cjs/package.json +0 -1
  101. package/bin/cjs/providers/AzureProvider.d.ts +0 -113
  102. package/bin/cjs/providers/AzureProvider.d.ts.map +0 -1
  103. package/bin/cjs/providers/AzureProvider.js +0 -127
  104. package/bin/cjs/providers/AzureProvider.js.map +0 -1
  105. package/bin/cjs/providers/LiveShareProvider.d.ts +0 -193
  106. package/bin/cjs/providers/LiveShareProvider.d.ts.map +0 -1
  107. package/bin/cjs/providers/LiveShareProvider.js +0 -205
  108. package/bin/cjs/providers/LiveShareProvider.js.map +0 -1
  109. package/bin/cjs/providers/index.d.ts +0 -3
  110. package/bin/cjs/providers/index.d.ts.map +0 -1
  111. package/bin/cjs/providers/index.js +0 -19
  112. package/bin/cjs/providers/index.js.map +0 -1
  113. package/bin/cjs/shared-hooks/index.d.ts +0 -7
  114. package/bin/cjs/shared-hooks/index.d.ts.map +0 -1
  115. package/bin/cjs/shared-hooks/index.js +0 -23
  116. package/bin/cjs/shared-hooks/index.js.map +0 -1
  117. package/bin/cjs/shared-hooks/internals/tree-node-constants.d.ts +0 -3
  118. package/bin/cjs/shared-hooks/internals/tree-node-constants.d.ts.map +0 -1
  119. package/bin/cjs/shared-hooks/internals/tree-node-constants.js +0 -6
  120. package/bin/cjs/shared-hooks/internals/tree-node-constants.js.map +0 -1
  121. package/bin/cjs/shared-hooks/internals/tree-node-types.d.ts +0 -10
  122. package/bin/cjs/shared-hooks/internals/tree-node-types.d.ts.map +0 -1
  123. package/bin/cjs/shared-hooks/internals/tree-node-types.js +0 -23
  124. package/bin/cjs/shared-hooks/internals/tree-node-types.js.map +0 -1
  125. package/bin/cjs/shared-hooks/internals/tree-node-utils.d.ts +0 -33
  126. package/bin/cjs/shared-hooks/internals/tree-node-utils.d.ts.map +0 -1
  127. package/bin/cjs/shared-hooks/internals/tree-node-utils.js +0 -193
  128. package/bin/cjs/shared-hooks/internals/tree-node-utils.js.map +0 -1
  129. package/bin/cjs/shared-hooks/useDynamicDDS.d.ts +0 -23
  130. package/bin/cjs/shared-hooks/useDynamicDDS.d.ts.map +0 -1
  131. package/bin/cjs/shared-hooks/useDynamicDDS.js +0 -87
  132. package/bin/cjs/shared-hooks/useDynamicDDS.js.map +0 -1
  133. package/bin/cjs/shared-hooks/useSharedMap.d.ts +0 -25
  134. package/bin/cjs/shared-hooks/useSharedMap.d.ts.map +0 -1
  135. package/bin/cjs/shared-hooks/useSharedMap.js +0 -134
  136. package/bin/cjs/shared-hooks/useSharedMap.js.map +0 -1
  137. package/bin/cjs/shared-hooks/useSharedState.d.ts +0 -22
  138. package/bin/cjs/shared-hooks/useSharedState.d.ts.map +0 -1
  139. package/bin/cjs/shared-hooks/useSharedState.js +0 -80
  140. package/bin/cjs/shared-hooks/useSharedState.js.map +0 -1
  141. package/bin/cjs/shared-hooks/useSharedStateRegistry.d.ts +0 -37
  142. package/bin/cjs/shared-hooks/useSharedStateRegistry.d.ts.map +0 -1
  143. package/bin/cjs/shared-hooks/useSharedStateRegistry.js +0 -120
  144. package/bin/cjs/shared-hooks/useSharedStateRegistry.js.map +0 -1
  145. package/bin/cjs/shared-hooks/useSharedTree.d.ts +0 -57
  146. package/bin/cjs/shared-hooks/useSharedTree.d.ts.map +0 -1
  147. package/bin/cjs/shared-hooks/useSharedTree.js +0 -123
  148. package/bin/cjs/shared-hooks/useSharedTree.js.map +0 -1
  149. package/bin/cjs/shared-hooks/useTreeNode.d.ts +0 -96
  150. package/bin/cjs/shared-hooks/useTreeNode.d.ts.map +0 -1
  151. package/bin/cjs/shared-hooks/useTreeNode.js +0 -135
  152. package/bin/cjs/shared-hooks/useTreeNode.js.map +0 -1
  153. package/bin/cjs/types/ActionTypes.d.ts +0 -112
  154. package/bin/cjs/types/ActionTypes.d.ts.map +0 -1
  155. package/bin/cjs/types/ActionTypes.js +0 -7
  156. package/bin/cjs/types/ActionTypes.js.map +0 -1
  157. package/bin/cjs/types/PropTypes.d.ts +0 -56
  158. package/bin/cjs/types/PropTypes.d.ts.map +0 -1
  159. package/bin/cjs/types/PropTypes.js +0 -7
  160. package/bin/cjs/types/PropTypes.js.map +0 -1
  161. package/bin/cjs/types/ResultTypes.d.ts +0 -334
  162. package/bin/cjs/types/ResultTypes.d.ts.map +0 -1
  163. package/bin/cjs/types/ResultTypes.js +0 -7
  164. package/bin/cjs/types/ResultTypes.js.map +0 -1
  165. package/bin/cjs/types/index.d.ts +0 -4
  166. package/bin/cjs/types/index.d.ts.map +0 -1
  167. package/bin/cjs/types/index.js +0 -20
  168. package/bin/cjs/types/index.js.map +0 -1
  169. package/bin/cjs/utils/index.d.ts +0 -2
  170. package/bin/cjs/utils/index.d.ts.map +0 -1
  171. package/bin/cjs/utils/index.js +0 -18
  172. package/bin/cjs/utils/index.js.map +0 -1
  173. package/bin/cjs/utils/type-check.d.ts +0 -15
  174. package/bin/cjs/utils/type-check.d.ts.map +0 -1
  175. package/bin/cjs/utils/type-check.js +0 -62
  176. package/bin/cjs/utils/type-check.js.map +0 -1
  177. package/bin/index.d.ts +0 -7
  178. package/bin/index.d.ts.map +0 -1
  179. package/bin/index.js +0 -7
  180. package/bin/index.js.map +0 -1
  181. package/bin/interfaces/LiveInterfaceExtensions.d.ts +0 -26
  182. package/bin/interfaces/LiveInterfaceExtensions.d.ts.map +0 -1
  183. package/bin/interfaces/LiveInterfaceExtensions.js +0 -6
  184. package/bin/interfaces/LiveInterfaceExtensions.js.map +0 -1
  185. package/bin/interfaces/index.d.ts +0 -2
  186. package/bin/interfaces/index.d.ts.map +0 -1
  187. package/bin/interfaces/index.js +0 -2
  188. package/bin/interfaces/index.js.map +0 -1
  189. package/bin/internal/errors.d.ts +0 -41
  190. package/bin/internal/errors.d.ts.map +0 -1
  191. package/bin/internal/errors.js +0 -42
  192. package/bin/internal/errors.js.map +0 -1
  193. package/bin/internal/index.d.ts +0 -3
  194. package/bin/internal/index.d.ts.map +0 -1
  195. package/bin/internal/index.js +0 -3
  196. package/bin/internal/index.js.map +0 -1
  197. package/bin/internal/type-guards.d.ts +0 -11
  198. package/bin/internal/type-guards.d.ts.map +0 -1
  199. package/bin/internal/type-guards.js +0 -20
  200. package/bin/internal/type-guards.js.map +0 -1
  201. package/bin/live-hooks/index.d.ts +0 -8
  202. package/bin/live-hooks/index.d.ts.map +0 -1
  203. package/bin/live-hooks/index.js +0 -8
  204. package/bin/live-hooks/index.js.map +0 -1
  205. package/bin/live-hooks/useLiveCanvas.d.ts +0 -29
  206. package/bin/live-hooks/useLiveCanvas.d.ts.map +0 -1
  207. package/bin/live-hooks/useLiveCanvas.js +0 -160
  208. package/bin/live-hooks/useLiveCanvas.js.map +0 -1
  209. package/bin/live-hooks/useLiveEvent.d.ts +0 -23
  210. package/bin/live-hooks/useLiveEvent.d.ts.map +0 -1
  211. package/bin/live-hooks/useLiveEvent.js +0 -108
  212. package/bin/live-hooks/useLiveEvent.js.map +0 -1
  213. package/bin/live-hooks/useLiveFollowMode.d.ts +0 -24
  214. package/bin/live-hooks/useLiveFollowMode.d.ts.map +0 -1
  215. package/bin/live-hooks/useLiveFollowMode.js +0 -211
  216. package/bin/live-hooks/useLiveFollowMode.js.map +0 -1
  217. package/bin/live-hooks/useLivePresence.d.ts +0 -26
  218. package/bin/live-hooks/useLivePresence.d.ts.map +0 -1
  219. package/bin/live-hooks/useLivePresence.js +0 -106
  220. package/bin/live-hooks/useLivePresence.js.map +0 -1
  221. package/bin/live-hooks/useLiveState.d.ts +0 -21
  222. package/bin/live-hooks/useLiveState.d.ts.map +0 -1
  223. package/bin/live-hooks/useLiveState.js +0 -83
  224. package/bin/live-hooks/useLiveState.js.map +0 -1
  225. package/bin/live-hooks/useLiveTimer.d.ts +0 -25
  226. package/bin/live-hooks/useLiveTimer.d.ts.map +0 -1
  227. package/bin/live-hooks/useLiveTimer.js +0 -172
  228. package/bin/live-hooks/useLiveTimer.js.map +0 -1
  229. package/bin/live-hooks/useMediaSynchronizer.d.ts +0 -25
  230. package/bin/live-hooks/useMediaSynchronizer.d.ts.map +0 -1
  231. package/bin/live-hooks/useMediaSynchronizer.js +0 -234
  232. package/bin/live-hooks/useMediaSynchronizer.js.map +0 -1
  233. package/bin/providers/AzureProvider.d.ts +0 -113
  234. package/bin/providers/AzureProvider.d.ts.map +0 -1
  235. package/bin/providers/AzureProvider.js +0 -119
  236. package/bin/providers/AzureProvider.js.map +0 -1
  237. package/bin/providers/LiveShareProvider.d.ts +0 -91
  238. package/bin/providers/LiveShareProvider.d.ts.map +0 -1
  239. package/bin/providers/LiveShareProvider.js +0 -95
  240. package/bin/providers/LiveShareProvider.js.map +0 -1
  241. package/bin/providers/index.d.ts +0 -3
  242. package/bin/providers/index.d.ts.map +0 -1
  243. package/bin/providers/index.js +0 -3
  244. package/bin/providers/index.js.map +0 -1
  245. package/bin/shared-hooks/index.d.ts +0 -5
  246. package/bin/shared-hooks/index.d.ts.map +0 -1
  247. package/bin/shared-hooks/index.js +0 -5
  248. package/bin/shared-hooks/index.js.map +0 -1
  249. package/bin/shared-hooks/useDynamicDDS.d.ts +0 -23
  250. package/bin/shared-hooks/useDynamicDDS.d.ts.map +0 -1
  251. package/bin/shared-hooks/useDynamicDDS.js +0 -72
  252. package/bin/shared-hooks/useDynamicDDS.js.map +0 -1
  253. package/bin/shared-hooks/useSharedMap.d.ts +0 -23
  254. package/bin/shared-hooks/useSharedMap.d.ts.map +0 -1
  255. package/bin/shared-hooks/useSharedMap.js +0 -114
  256. package/bin/shared-hooks/useSharedMap.js.map +0 -1
  257. package/bin/shared-hooks/useSharedState.d.ts +0 -22
  258. package/bin/shared-hooks/useSharedState.d.ts.map +0 -1
  259. package/bin/shared-hooks/useSharedState.js +0 -74
  260. package/bin/shared-hooks/useSharedState.js.map +0 -1
  261. package/bin/shared-hooks/useSharedStateRegistry.d.ts +0 -37
  262. package/bin/shared-hooks/useSharedStateRegistry.d.ts.map +0 -1
  263. package/bin/shared-hooks/useSharedStateRegistry.js +0 -105
  264. package/bin/shared-hooks/useSharedStateRegistry.js.map +0 -1
  265. package/bin/types/ActionTypes.d.ts +0 -112
  266. package/bin/types/ActionTypes.d.ts.map +0 -1
  267. package/bin/types/ActionTypes.js +0 -6
  268. package/bin/types/ActionTypes.js.map +0 -1
  269. package/bin/types/PropTypes.d.ts +0 -8
  270. package/bin/types/PropTypes.d.ts.map +0 -1
  271. package/bin/types/PropTypes.js +0 -6
  272. package/bin/types/PropTypes.js.map +0 -1
  273. package/bin/types/ResultTypes.d.ts +0 -302
  274. package/bin/types/ResultTypes.d.ts.map +0 -1
  275. package/bin/types/ResultTypes.js +0 -6
  276. package/bin/types/ResultTypes.js.map +0 -1
  277. package/bin/types/index.d.ts +0 -4
  278. package/bin/types/index.d.ts.map +0 -1
  279. package/bin/types/index.js +0 -4
  280. package/bin/types/index.js.map +0 -1
  281. package/bin/utils/index.d.ts +0 -2
  282. package/bin/utils/index.d.ts.map +0 -1
  283. package/bin/utils/index.js +0 -2
  284. package/bin/utils/index.js.map +0 -1
  285. package/bin/utils/type-check.d.ts +0 -15
  286. package/bin/utils/type-check.d.ts.map +0 -1
  287. package/bin/utils/type-check.js +0 -54
  288. package/bin/utils/type-check.js.map +0 -1
  289. package/tsconfig.cjs.json +0 -14
@@ -1,62 +0,0 @@
1
- "use strict";
2
- /*!
3
- * Copyright (c) Microsoft Corporation. All rights reserved.
4
- * Licensed under the Microsoft Live Share SDK License.
5
- */
6
- Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.isRefObject = isRefObject;
8
- exports.isMediaElement = isMediaElement;
9
- exports.isExtendedMediaMetadata = isExtendedMediaMetadata;
10
- exports.isMap = isMap;
11
- exports.isEntries = isEntries;
12
- exports.isJSON = isJSON;
13
- function isRefObject(value) {
14
- return value.current === null || !!value.current;
15
- }
16
- function isMediaElement(value) {
17
- if (value) {
18
- return (value.currentSrc !== undefined &&
19
- value.currentTime !== undefined &&
20
- value.duration !== undefined &&
21
- value.ended !== undefined &&
22
- value.muted !== undefined &&
23
- value.paused !== undefined &&
24
- value.playbackRate !== undefined &&
25
- value.src !== undefined &&
26
- value.volume !== undefined &&
27
- value.load !== undefined &&
28
- value.pause !== undefined &&
29
- value.play !== undefined &&
30
- value.addEventListener !== undefined &&
31
- value.removeEventListener !== undefined);
32
- }
33
- return false;
34
- }
35
- function isExtendedMediaMetadata(value) {
36
- return value === null || !!(value === null || value === void 0 ? void 0 : value.trackIdentifier);
37
- }
38
- function isMap(value) {
39
- return value instanceof Map;
40
- }
41
- function isEntries(value) {
42
- try {
43
- const tryValue = value;
44
- if (typeof tryValue[0][0] === "string") {
45
- return true;
46
- }
47
- return false;
48
- }
49
- catch (error) {
50
- return false;
51
- }
52
- }
53
- function isJSON(value) {
54
- try {
55
- const tryValue = value;
56
- return Object.keys(tryValue).length > 0;
57
- }
58
- catch (error) {
59
- return false;
60
- }
61
- }
62
- //# sourceMappingURL=type-check.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"type-check.js","sourceRoot":"","sources":["../../../src/utils/type-check.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAQH,kCAEC;AAED,wCAoBC;AAED,0DAIC;AAED,sBAEC;AAED,8BAYC;AAED,wBAOC;AAzDD,SAAgB,WAAW,CAAI,KAAU;IACrC,OAAO,KAAK,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;AACrD,CAAC;AAED,SAAgB,cAAc,CAAC,KAAU;IACrC,IAAI,KAAK,EAAE,CAAC;QACR,OAAO,CACH,KAAK,CAAC,UAAU,KAAK,SAAS;YAC9B,KAAK,CAAC,WAAW,KAAK,SAAS;YAC/B,KAAK,CAAC,QAAQ,KAAK,SAAS;YAC5B,KAAK,CAAC,KAAK,KAAK,SAAS;YACzB,KAAK,CAAC,KAAK,KAAK,SAAS;YACzB,KAAK,CAAC,MAAM,KAAK,SAAS;YAC1B,KAAK,CAAC,YAAY,KAAK,SAAS;YAChC,KAAK,CAAC,GAAG,KAAK,SAAS;YACvB,KAAK,CAAC,MAAM,KAAK,SAAS;YAC1B,KAAK,CAAC,IAAI,KAAK,SAAS;YACxB,KAAK,CAAC,KAAK,KAAK,SAAS;YACzB,KAAK,CAAC,IAAI,KAAK,SAAS;YACxB,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACpC,KAAK,CAAC,mBAAmB,KAAK,SAAS,CAC1C,CAAC;IACN,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAgB,uBAAuB,CACnC,KAAU;IAEV,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA,CAAC;AACtD,CAAC;AAED,SAAgB,KAAK,CAAC,KAAU;IAC5B,OAAO,KAAK,YAAY,GAAG,CAAC;AAChC,CAAC;AAED,SAAgB,SAAS,CACrB,KAAU;IAEV,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,KAAyC,CAAC;QAC3D,IAAI,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,SAAgB,MAAM,CAAC,KAAU;IAC7B,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,KAA+B,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC"}
package/bin/index.d.ts DELETED
@@ -1,7 +0,0 @@
1
- export * from "./providers";
2
- export * from "./shared-hooks";
3
- export * from "./live-hooks";
4
- export * from "./types";
5
- export * from "./providers";
6
- export * from "./interfaces";
7
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
package/bin/index.js DELETED
@@ -1,7 +0,0 @@
1
- export * from "./providers";
2
- export * from "./shared-hooks";
3
- export * from "./live-hooks";
4
- export * from "./types";
5
- export * from "./providers";
6
- export * from "./interfaces";
7
- //# sourceMappingURL=index.js.map
package/bin/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
@@ -1,26 +0,0 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the Microsoft Live Share SDK License.
4
- */
5
- /**
6
- * Object response for a received event
7
- */
8
- export interface IReceiveLiveEvent<TEvent = any> {
9
- /**
10
- * The value of the event that was sent
11
- */
12
- value: TEvent;
13
- /**
14
- * True if the local client was the one to send this event
15
- */
16
- local: boolean;
17
- /**
18
- * Client ID of the user that sent the event
19
- */
20
- clientId: string;
21
- /**
22
- * Server timestamp at which the event was sent
23
- */
24
- timestamp: number;
25
- }
26
- //# sourceMappingURL=LiveInterfaceExtensions.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"LiveInterfaceExtensions.d.ts","sourceRoot":"","sources":["../../src/interfaces/LiveInterfaceExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,MAAM,GAAG,GAAG;IAC3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB"}
@@ -1,6 +0,0 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the Microsoft Live Share SDK License.
4
- */
5
- export {};
6
- //# sourceMappingURL=LiveInterfaceExtensions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"LiveInterfaceExtensions.js","sourceRoot":"","sources":["../../src/interfaces/LiveInterfaceExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
@@ -1,2 +0,0 @@
1
- export * from "./LiveInterfaceExtensions";
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
@@ -1,2 +0,0 @@
1
- export * from "./LiveInterfaceExtensions";
2
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
@@ -1,41 +0,0 @@
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
- /**
26
- * @hidden
27
- */
28
- export interface ITeamsJsSdkError {
29
- /**
30
- * error code
31
- */
32
- errorCode: number;
33
- /**
34
- * Optional description for the error. This may contain useful information for web-app developers.
35
- * This string will not be localized and is not for end-user consumption.
36
- * App should not depend on the string content. The exact value may change. This is only for debugging purposes.
37
- */
38
- message?: string;
39
- }
40
- export {};
41
- //# sourceMappingURL=errors.d.ts.map
@@ -1 +0,0 @@
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;CAIrE;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,4BAA4B;gBAC/D,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAOpD;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,4BAA4B;gBACpE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAQpD;AAED;;GAEG;AACH,qBAAa,oCAAqC,SAAQ,4BAA4B;gBACtE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAQpD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB"}
@@ -1,42 +0,0 @@
1
- /**
2
- * @hidden
3
- */
4
- class UseLiveDataObjectActionError extends Error {
5
- constructor(ddsName, functionName, message) {
6
- const hookName = `use${toFirstLetterUppercase(ddsName)}`;
7
- super(`${hookName} ${functionName}: ${message}`);
8
- }
9
- }
10
- /**
11
- * @hidden
12
- */
13
- export class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
14
- constructor(ddsName, functionName) {
15
- super(ddsName, functionName, "container has not yet been joined.\nTo fix this error, ensure `container` from `useFluidObjectsContext()` is defined before calling this function.\nIf using `<LiveShareProvider>`, you can instead check the `joined` response is true from `useLiveShareContext()` before calling this function.");
16
- }
17
- }
18
- /**
19
- * @hidden
20
- */
21
- export class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
22
- constructor(ddsName, functionName) {
23
- const hookName = `use${toFirstLetterUppercase(ddsName)}`;
24
- super(ddsName, functionName, `${ddsName} is undefined, which means it is still being dynamically created.\nTo fix this error, ensure that \`${ddsName}\` (found in the response of \`${hookName}\`) is defined before calling this function.`);
25
- }
26
- }
27
- /**
28
- * @hidden
29
- */
30
- export class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
31
- constructor(ddsName, functionName) {
32
- const hookName = `use${toFirstLetterUppercase(ddsName)}`;
33
- super(ddsName, functionName, `${ddsName} is not yet initialized.\nTo fix this error, ensure that \`${ddsName}?.isInitialized\` is true (found in the response of \`${hookName}\`) before calling this function.`);
34
- }
35
- }
36
- /**
37
- * @hidden
38
- */
39
- function toFirstLetterUppercase(word) {
40
- return word[0].toUpperCase() + word.substring(1);
41
- }
42
- //# sourceMappingURL=errors.js.map
@@ -1 +0,0 @@
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,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,KAAK,CAAC,GAAG,QAAQ,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,4BAA4B;IAC3E,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CACD,OAAO,EACP,YAAY,EACZ,oSAAoS,CACvS,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,kCAAmC,SAAQ,4BAA4B;IAChF,YAAY,OAAe,EAAE,YAAoB;QAC7C,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,KAAK,CACD,OAAO,EACP,YAAY,EACZ,GAAG,OAAO,uGAAuG,OAAO,kCAAkC,QAAQ,8CAA8C,CACnN,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,4BAA4B;IAClF,YAAY,OAAe,EAAE,YAAoB;QAC7C,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,KAAK,CACD,OAAO,EACP,YAAY,EACZ,GAAG,OAAO,8DAA8D,OAAO,yDAAyD,QAAQ,mCAAmC,CACtL,CAAC;IACN,CAAC;CACJ;AAkBD;;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"}
@@ -1,3 +0,0 @@
1
- export * from "./errors";
2
- export * from "./type-guards";
3
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}
@@ -1,3 +0,0 @@
1
- export * from "./errors";
2
- export * from "./type-guards";
3
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}
@@ -1,11 +0,0 @@
1
- import { ITeamsJsSdkError } from "./errors";
2
- /**
3
- * @hidden
4
- * Used for useLiveState and useSharedState for checking if a value is a prevState callback
5
- */
6
- export declare function isPrevStateCallback<TState>(value: any): value is (value: TState) => TState;
7
- /**
8
- * @hidden
9
- */
10
- export declare function isITeamsJsSdkError(value: any): value is ITeamsJsSdkError;
11
- //# sourceMappingURL=type-guards.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EACtC,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAEpC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,gBAAgB,CAKxE"}
@@ -1,20 +0,0 @@
1
- /**
2
- * @hidden
3
- * Used for useLiveState and useSharedState for checking if a value is a prevState callback
4
- */
5
- export function isPrevStateCallback(value) {
6
- return typeof value === "function";
7
- }
8
- /**
9
- * @hidden
10
- */
11
- export function isITeamsJsSdkError(value) {
12
- if (!value)
13
- return false;
14
- if (typeof value.errorCode !== "number")
15
- return false;
16
- if (value.message === undefined)
17
- return true;
18
- return typeof value.message === "string";
19
- }
20
- //# sourceMappingURL=type-guards.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAC/B,KAAU;IAEV,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAU;IACzC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC7C,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC;AAC7C,CAAC"}
@@ -1,8 +0,0 @@
1
- export * from "./useLivePresence";
2
- export * from "./useLiveFollowMode";
3
- export * from "./useLiveState";
4
- export * from "./useMediaSynchronizer";
5
- export * from "./useLiveEvent";
6
- export * from "./useLiveCanvas";
7
- export * from "./useLiveTimer";
8
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/live-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}
@@ -1,8 +0,0 @@
1
- export * from "./useLivePresence";
2
- export * from "./useLiveFollowMode";
3
- export * from "./useLiveState";
4
- export * from "./useMediaSynchronizer";
5
- export * from "./useLiveEvent";
6
- export * from "./useLiveCanvas";
7
- export * from "./useLiveTimer";
8
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/live-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}
@@ -1,29 +0,0 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the Microsoft Live Share SDK License.
4
- */
5
- import { CanvasReferencePoint, IBrush, InkingTool, IPoint } from "@microsoft/live-share-canvas";
6
- import React from "react";
7
- import { IUseLiveCanvasResults } from "../types";
8
- /**
9
- * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
10
- *
11
- * @remarks
12
- * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
13
- * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
14
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
15
- *
16
- * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
17
- * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
18
- * @param active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
19
- * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
20
- * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
21
- * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
22
- * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
23
- * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
24
- * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
25
- * @param localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
26
- * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
27
- */
28
- export declare function useLiveCanvas(uniqueKey: string, canvasElementRef: React.RefObject<HTMLElement | null> | string, active?: boolean, tool?: InkingTool, lineBrush?: IBrush, offset?: IPoint, scale?: number, referencePoint?: CanvasReferencePoint, isCursorShared?: boolean, localUserPictureUrl?: string): IUseLiveCanvasResults;
29
- //# sourceMappingURL=useLiveCanvas.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useLiveCanvas.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,MAAM,EAEN,UAAU,EACV,MAAM,EAET,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,MAAM,EAC9D,MAAM,CAAC,EAAE,OAAO,EAChB,IAAI,CAAC,EAAE,UAAU,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,oBAAoB,EACrC,cAAc,CAAC,EAAE,OAAO,EACxB,mBAAmB,CAAC,EAAE,MAAM,GAC7B,qBAAqB,CA6IvB"}
@@ -1,160 +0,0 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the Microsoft Live Share SDK License.
4
- */
5
- import { InkingManager, LiveCanvas, } from "@microsoft/live-share-canvas";
6
- import React from "react";
7
- import { useDynamicDDS } from "../shared-hooks";
8
- import { isRefObject } from "../utils";
9
- /**
10
- * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
11
- *
12
- * @remarks
13
- * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
14
- * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
15
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
16
- *
17
- * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
18
- * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
19
- * @param active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
20
- * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
21
- * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
22
- * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
23
- * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
24
- * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
25
- * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
26
- * @param localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
27
- * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
28
- */
29
- export function useLiveCanvas(uniqueKey, canvasElementRef, active, tool, lineBrush, offset, scale, referencePoint, isCursorShared, localUserPictureUrl) {
30
- /**
31
- * User facing: inking manager instance
32
- */
33
- const [inkingManager, setInkingManager] = React.useState();
34
- /**
35
- * User facing: dynamically load the DDS for the given unique key.
36
- */
37
- const { dds: liveCanvas } = useDynamicDDS(uniqueKey, LiveCanvas);
38
- /**
39
- * Setup the InkingManager and LiveCanvas
40
- */
41
- React.useEffect(() => {
42
- // if the component is already listening or liveCanvas is not yet initialized, return
43
- if (!liveCanvas)
44
- return;
45
- // get the canvas element from the ref or document
46
- let htmlElement;
47
- if (isRefObject(canvasElementRef)) {
48
- htmlElement = canvasElementRef.current;
49
- }
50
- else {
51
- htmlElement = document.getElementById(canvasElementRef);
52
- }
53
- if (htmlElement === null)
54
- return;
55
- // Create the InkingManager and initialize the liveCanvas with it
56
- const inkingManager = new InkingManager(htmlElement);
57
- setInkingManager(inkingManager);
58
- liveCanvas.initialize(inkingManager);
59
- // cleanup function to be called when the component is unmount
60
- return () => {
61
- liveCanvas.dispose();
62
- inkingManager.removeAllListeners();
63
- };
64
- }, [liveCanvas]);
65
- /**
66
- * Activate or deactivate the inkingManager based on the 'active' prop
67
- */
68
- React.useEffect(() => {
69
- if (inkingManager && active !== undefined) {
70
- if (active) {
71
- inkingManager.activate();
72
- }
73
- else {
74
- inkingManager.deactivate();
75
- }
76
- }
77
- }, [active, inkingManager]);
78
- /**
79
- * Sets the tool of the inkingManager based on the 'tool' prop
80
- */
81
- React.useEffect(() => {
82
- if (inkingManager && tool !== undefined) {
83
- inkingManager.tool = tool;
84
- }
85
- }, [tool, inkingManager]);
86
- /**
87
- * Sets the offset of the inkingManager based on the 'offset' prop
88
- */
89
- React.useEffect(() => {
90
- if (inkingManager && offset !== undefined) {
91
- inkingManager.offset = {
92
- x: offset.x,
93
- y: offset.y,
94
- };
95
- }
96
- }, [offset === null || offset === void 0 ? void 0 : offset.x, offset === null || offset === void 0 ? void 0 : offset.y, inkingManager]);
97
- /**
98
- * Sets the scale of the inkingManager based on the 'scale' prop
99
- */
100
- React.useEffect(() => {
101
- if (inkingManager && scale !== undefined) {
102
- inkingManager.scale = scale;
103
- }
104
- }, [scale, inkingManager]);
105
- /**
106
- * Sets the referencePoint of the inkingManager based on the 'referencePoint' prop
107
- */
108
- React.useEffect(() => {
109
- if (inkingManager && referencePoint !== undefined) {
110
- inkingManager.referencePoint = referencePoint;
111
- }
112
- }, [referencePoint, inkingManager]);
113
- /**
114
- * Sets the lineBrush of the inkingManager based on the 'lineBrush' prop
115
- */
116
- React.useEffect(() => {
117
- if (inkingManager && lineBrush) {
118
- inkingManager.lineBrush = {
119
- color: lineBrush.color,
120
- tip: lineBrush.tip,
121
- tipSize: lineBrush.tipSize,
122
- type: lineBrush.type,
123
- endArrow: lineBrush.endArrow,
124
- };
125
- }
126
- }, [
127
- lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.color,
128
- lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tip,
129
- lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tipSize,
130
- lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.type,
131
- lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.endArrow,
132
- inkingManager,
133
- ]);
134
- /**
135
- * Sets the isCursorShared of the liveCanvas based on the 'isCursorShared' prop
136
- */
137
- React.useEffect(() => {
138
- if (liveCanvas && isCursorShared !== undefined) {
139
- liveCanvas.isCursorShared = isCursorShared;
140
- }
141
- }, [isCursorShared, liveCanvas]);
142
- /**
143
- * Sets the onGetLocalUserInfo method of the liveCanvas based on the 'localUserCursor' prop
144
- */
145
- React.useEffect(() => {
146
- if (liveCanvas && localUserPictureUrl) {
147
- liveCanvas.onGetLocalUserPictureUrl = () => {
148
- return localUserPictureUrl;
149
- };
150
- }
151
- }, [localUserPictureUrl, liveCanvas]);
152
- /**
153
- * Return hook response
154
- */
155
- return {
156
- inkingManager,
157
- liveCanvas,
158
- };
159
- }
160
- //# sourceMappingURL=useLiveCanvas.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useLiveCanvas.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,aAAa,EAGb,UAAU,GACb,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,aAAa,CACzB,SAAiB,EACjB,gBAA8D,EAC9D,MAAgB,EAChB,IAAiB,EACjB,SAAkB,EAClB,MAAe,EACf,KAAc,EACd,cAAqC,EACrC,cAAwB,EACxB,mBAA4B;IAE5B;;OAEG;IACH,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAiB,CAAC;IAE1E;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,aAAa,CACrC,SAAS,EACT,UAAU,CACb,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,qFAAqF;QACrF,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,kDAAkD;QAClD,IAAI,WAA+B,CAAC;QACpC,IAAI,WAAW,CAAC,gBAAgB,CAAC,EAAE;YAC/B,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC;SAC1C;aAAM;YACH,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;SAC3D;QACD,IAAI,WAAW,KAAK,IAAI;YAAE,OAAO;QACjC,iEAAiE;QACjE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;QACrD,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAChC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAErC,8DAA8D;QAC9D,OAAO,GAAG,EAAE;YACR,UAAU,CAAC,OAAO,EAAE,CAAC;YACrB,aAAa,CAAC,kBAAkB,EAAE,CAAC;QACvC,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,MAAM,KAAK,SAAS,EAAE;YACvC,IAAI,MAAM,EAAE;gBACR,aAAa,CAAC,QAAQ,EAAE,CAAC;aAC5B;iBAAM;gBACH,aAAa,CAAC,UAAU,EAAE,CAAC;aAC9B;SACJ;IACL,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,IAAI,KAAK,SAAS,EAAE;YACrC,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;SAC7B;IACL,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,MAAM,KAAK,SAAS,EAAE;YACvC,aAAa,CAAC,MAAM,GAAG;gBACnB,CAAC,EAAE,MAAM,CAAC,CAAC;gBACX,CAAC,EAAE,MAAM,CAAC,CAAC;aACd,CAAC;SACL;IACL,CAAC,EAAE,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,KAAK,KAAK,SAAS,EAAE;YACtC,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;SAC/B;IACL,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,cAAc,KAAK,SAAS,EAAE;YAC/C,aAAa,CAAC,cAAc,GAAG,cAAc,CAAC;SACjD;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,SAAS,EAAE;YAC5B,aAAa,CAAC,SAAS,GAAG;gBACtB,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,GAAG,EAAE,SAAS,CAAC,GAAG;gBAClB,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;aAC/B,CAAC;SACL;IACL,CAAC,EAAE;QACC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK;QAChB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG;QACd,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO;QAClB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI;QACf,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ;QACnB,aAAa;KAChB,CAAC,CAAC;IAEH;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,UAAU,IAAI,cAAc,KAAK,SAAS,EAAE;YAC5C,UAAU,CAAC,cAAc,GAAG,cAAc,CAAC;SAC9C;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,UAAU,IAAI,mBAAmB,EAAE;YACnC,UAAU,CAAC,wBAAwB,GAAG,GAAuB,EAAE;gBAC3D,OAAO,mBAAmB,CAAC;YAC/B,CAAC,CAAC;SACL;IACL,CAAC,EAAE,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO;QACH,aAAa;QACb,UAAU;KACb,CAAC;AACN,CAAC"}
@@ -1,23 +0,0 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the Microsoft Live Share SDK License.
4
- */
5
- import { UserMeetingRole } from "@microsoft/live-share";
6
- import { IUseLiveEventResults, OnReceivedLiveEventAction } from "../types";
7
- /**
8
- * React hook for using a Live Share `LiveEvent`.
9
- *
10
- * @remarks
11
- * Use this hook if you want to send transient JSON objects to everyone connected to the Fluid container,
12
- * such as when sending push notifications or reactions.
13
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
14
- *
15
- * @template TEvent Optional typing for events sent & received. Default is `object` type.
16
- * @param uniqueKey the unique key for the `LiveEvent`. If one does not yet exist, a new one
17
- * will be created, otherwise it will use the existing one.
18
- * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
19
- * @param onReceivedEvent Optional. Callback method to be called when a new notification is received.
20
- * @returns stateful `latestEvent` & `allEvents` list, `sendEvent` callback, and the `liveEvent` object.
21
- */
22
- export declare function useLiveEvent<TEvent = any>(uniqueKey: string, allowedRoles?: UserMeetingRole[], onReceivedEvent?: OnReceivedLiveEventAction<TEvent>): IUseLiveEventResults<TEvent>;
23
- //# sourceMappingURL=useLiveEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useLiveEvent.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAGlB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EACpB,yBAAyB,EAE5B,MAAM,UAAU,CAAC;AAUlB;;;;;;;;;;;;;;GAcG;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,CAoG9B"}