@adonis-agora/collaboration-client 0.4.1 → 0.5.0
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.
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as AwarenessProtocol from 'y-protocols/awareness.js';
|
|
1
2
|
import type { CollabPeer, CollabStatus } from '../types.js';
|
|
2
3
|
export interface UseAwarenessOptions {
|
|
3
4
|
docName: string;
|
|
@@ -6,6 +7,16 @@ export interface UseAwarenessResult {
|
|
|
6
7
|
/** Peers conectados (sem o usuário local). */
|
|
7
8
|
peers: CollabPeer[];
|
|
8
9
|
status: CollabStatus;
|
|
10
|
+
/**
|
|
11
|
+
* The document's raw awareness channel, or null before the transport
|
|
12
|
+
* connects (and on engines that have none).
|
|
13
|
+
*
|
|
14
|
+
* `peers` covers rendering an avatar stack; this is for editor extensions
|
|
15
|
+
* that drive their own remote carets from awareness — Tiptap's
|
|
16
|
+
* CollaborationCursor takes a `provider` and reads `provider.awareness`,
|
|
17
|
+
* so it needs the object rather than a snapshot.
|
|
18
|
+
*/
|
|
19
|
+
awareness: AwarenessProtocol.Awareness | null;
|
|
9
20
|
}
|
|
10
21
|
/**
|
|
11
22
|
* Presença via awareness: quem está online no documento agora.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use_awareness.d.ts","sourceRoot":"","sources":["../../../src/hooks/use_awareness.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"use_awareness.d.ts","sourceRoot":"","sources":["../../../src/hooks/use_awareness.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,iBAAiB,MAAM,0BAA0B,CAAC;AAEnE,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE5D,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB;;;;;;;;OAQG;IACH,SAAS,EAAE,iBAAiB,CAAC,SAAS,GAAG,IAAI,CAAC;CAC/C;AAmBD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,kBAAkB,CAkC7E"}
|
|
@@ -27,9 +27,13 @@ export function useAwareness(options) {
|
|
|
27
27
|
const session = getOrCreateSession(context, docName);
|
|
28
28
|
const [peers, setPeers] = useState([]);
|
|
29
29
|
const [status, setStatus] = useState(session.getStatus());
|
|
30
|
+
const [awareness, setAwareness] = useState(session.transport?.awareness ?? null);
|
|
30
31
|
useEffect(() => {
|
|
31
32
|
const update = () => {
|
|
32
33
|
setStatus(session.getStatus());
|
|
34
|
+
// The transport is rebuilt on every reconnect, so the awareness object
|
|
35
|
+
// is not stable — re-read it rather than capturing it once.
|
|
36
|
+
setAwareness(session.transport?.awareness ?? null);
|
|
33
37
|
if (session.transport?.awareness) {
|
|
34
38
|
setPeers(snapshotPeers(session.transport.awareness));
|
|
35
39
|
}
|
|
@@ -43,6 +47,6 @@ export function useAwareness(options) {
|
|
|
43
47
|
unsubscribe();
|
|
44
48
|
};
|
|
45
49
|
}, [session]);
|
|
46
|
-
return { peers, status };
|
|
50
|
+
return { peers, status, awareness };
|
|
47
51
|
}
|
|
48
52
|
//# sourceMappingURL=use_awareness.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use_awareness.js","sourceRoot":"","sources":["../../../src/hooks/use_awareness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"use_awareness.js","sourceRoot":"","sources":["../../../src/hooks/use_awareness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAuB5E,SAAS,aAAa,CAAC,SAAsC;IAC3D,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC;IACnC,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;QACtD,IAAI,QAAQ,KAAK,OAAO;YAAE,SAAS;QACnC,MAAM,IAAI,GAAI,KAAkF;aAC7F,IAAI,CAAC;QACR,KAAK,CAAC,IAAI,CAAC;YACT,QAAQ;YACR,MAAM,EAAE,IAAI,EAAE,MAAM;YACpB,IAAI,EAAE,IAAI,EAAE,IAAI;YAChB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,IAAI;SACnC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,OAA4B;IACvD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,MAAM,OAAO,GAAG,uBAAuB,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAe,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAe,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACxE,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CACxC,OAAO,CAAC,SAAS,EAAE,SAAS,IAAI,IAAI,CACrC,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,GAAG,EAAE;YAClB,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;YAC/B,uEAAuE;YACvE,4DAA4D;YAC5D,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,IAAI,IAAI,CAAC,CAAC;YACnD,IAAI,OAAO,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC;gBACjC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;YACvD,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,EAAE,CAAC;QACT,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE9C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC;QAC/C,SAAS,EAAE,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAEhC,OAAO,GAAG,EAAE;YACV,SAAS,EAAE,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACjC,WAAW,EAAE,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACtC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adonis-agora/collaboration-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Client-side React hooks for @adonis-agora/collaboration — collaborative docs, presence, comments and versions. Part of the Agora ecosystem.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -24,15 +24,6 @@
|
|
|
24
24
|
"README.md"
|
|
25
25
|
],
|
|
26
26
|
"sideEffects": false,
|
|
27
|
-
"scripts": {
|
|
28
|
-
"build": "pnpm run clean && tsc -p tsconfig.build.json",
|
|
29
|
-
"check:dist": "node ../../scripts/assert-build-output.mjs dist src/index.js",
|
|
30
|
-
"clean": "rm -rf dist",
|
|
31
|
-
"prepack": "pnpm run check:dist",
|
|
32
|
-
"test": "vitest run --passWithNoTests",
|
|
33
|
-
"test:watch": "vitest",
|
|
34
|
-
"typecheck": "tsc -p tsconfig.json --noEmit"
|
|
35
|
-
},
|
|
36
27
|
"dependencies": {
|
|
37
28
|
"@automerge/automerge": "^3.4.1",
|
|
38
29
|
"@hocuspocus/provider": "^4.6.0",
|
|
@@ -73,5 +64,13 @@
|
|
|
73
64
|
"realtime",
|
|
74
65
|
"react-hooks",
|
|
75
66
|
"agora"
|
|
76
|
-
]
|
|
77
|
-
|
|
67
|
+
],
|
|
68
|
+
"scripts": {
|
|
69
|
+
"build": "pnpm run clean && tsc -p tsconfig.build.json",
|
|
70
|
+
"check:dist": "node ../../scripts/assert-build-output.mjs dist src/index.js",
|
|
71
|
+
"clean": "rm -rf dist",
|
|
72
|
+
"test": "vitest run --passWithNoTests",
|
|
73
|
+
"test:watch": "vitest",
|
|
74
|
+
"typecheck": "tsc -p tsconfig.json --noEmit"
|
|
75
|
+
}
|
|
76
|
+
}
|