@adonis-agora/collaboration-client 0.6.1 → 0.7.1

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 (52) hide show
  1. package/dist/src/components/excalidraw_board.d.ts +2 -2
  2. package/dist/src/components/excalidraw_board.d.ts.map +1 -1
  3. package/dist/src/components/excalidraw_board.js +4 -6
  4. package/dist/src/components/excalidraw_board.js.map +1 -1
  5. package/dist/src/context.d.ts +15 -3
  6. package/dist/src/context.d.ts.map +1 -1
  7. package/dist/src/context.js +22 -8
  8. package/dist/src/context.js.map +1 -1
  9. package/dist/src/hooks/use_automerge_doc.d.ts +32 -0
  10. package/dist/src/hooks/use_automerge_doc.d.ts.map +1 -1
  11. package/dist/src/hooks/use_automerge_doc.js +137 -40
  12. package/dist/src/hooks/use_automerge_doc.js.map +1 -1
  13. package/dist/src/hooks/use_awareness.d.ts +30 -0
  14. package/dist/src/hooks/use_awareness.d.ts.map +1 -1
  15. package/dist/src/hooks/use_awareness.js +55 -14
  16. package/dist/src/hooks/use_awareness.js.map +1 -1
  17. package/dist/src/hooks/use_collab_doc.d.ts +17 -1
  18. package/dist/src/hooks/use_collab_doc.d.ts.map +1 -1
  19. package/dist/src/hooks/use_collab_doc.js +44 -19
  20. package/dist/src/hooks/use_collab_doc.js.map +1 -1
  21. package/dist/src/hooks/use_collab_editor.d.ts +5 -0
  22. package/dist/src/hooks/use_collab_editor.d.ts.map +1 -1
  23. package/dist/src/hooks/use_collab_editor.js +26 -17
  24. package/dist/src/hooks/use_collab_editor.js.map +1 -1
  25. package/dist/src/hooks/use_comments.d.ts +6 -1
  26. package/dist/src/hooks/use_comments.d.ts.map +1 -1
  27. package/dist/src/hooks/use_comments.js +4 -4
  28. package/dist/src/hooks/use_comments.js.map +1 -1
  29. package/dist/src/hooks/use_excalidraw_sync.d.ts +27 -6
  30. package/dist/src/hooks/use_excalidraw_sync.d.ts.map +1 -1
  31. package/dist/src/hooks/use_excalidraw_sync.js +56 -22
  32. package/dist/src/hooks/use_excalidraw_sync.js.map +1 -1
  33. package/dist/src/hooks/use_versions.js +2 -2
  34. package/dist/src/hooks/use_versions.js.map +1 -1
  35. package/dist/src/index.d.ts +4 -3
  36. package/dist/src/index.d.ts.map +1 -1
  37. package/dist/src/index.js.map +1 -1
  38. package/dist/src/rest_client.d.ts +11 -2
  39. package/dist/src/rest_client.d.ts.map +1 -1
  40. package/dist/src/rest_client.js +11 -2
  41. package/dist/src/rest_client.js.map +1 -1
  42. package/dist/src/session.d.ts +112 -4
  43. package/dist/src/session.d.ts.map +1 -1
  44. package/dist/src/session.js +198 -16
  45. package/dist/src/session.js.map +1 -1
  46. package/dist/src/transports/hocuspocus.d.ts +3 -0
  47. package/dist/src/transports/hocuspocus.d.ts.map +1 -1
  48. package/dist/src/transports/hocuspocus.js +23 -2
  49. package/dist/src/transports/hocuspocus.js.map +1 -1
  50. package/dist/src/types.d.ts +13 -2
  51. package/dist/src/types.d.ts.map +1 -1
  52. package/package.json +4 -1
@@ -1 +1 @@
1
- {"version":3,"file":"hocuspocus.js","sourceRoot":"","sources":["../../../src/transports/hocuspocus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAY1D,MAAM,OAAO,yBAAyB;IAC3B,GAAG,CAAQ;IACZ,QAAQ,CAAqB;IAC7B,MAAM,GAAuC,YAAY,CAAC;IAC1D,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,YAAY,IAAqB,EAAE,GAAU,EAAE,OAAe;QAC5D,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAEf,mEAAmE;QACnE,6CAA6C;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,GAAG,UAAU,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,IAAI,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAE9H,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAkB,CAAC;YACrC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAsB,EAAE,EAAE;YAC5D,IAAI,CAAC,MAAM;gBACT,MAAM,KAAK,WAAW;oBACpB,CAAC,CAAC,WAAW;oBACb,CAAC,CAAC,MAAM,KAAK,cAAc;wBACzB,CAAC,CAAC,cAAc;wBAChB,CAAC,CAAC,YAAY,CAAC;YACrB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS;gBAAE,QAAQ,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,SAAS,CAAC,QAAwB;QAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO;QACL,KAAK,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;CACF"}
1
+ {"version":3,"file":"hocuspocus.js","sourceRoot":"","sources":["../../../src/transports/hocuspocus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAY1D,MAAM,OAAO,yBAAyB;IAC3B,GAAG,CAAQ;IACZ,QAAQ,CAAqB;IAC7B,MAAM,GAAuC,YAAY,CAAC;IAC1D,MAAM,GAAG,KAAK,CAAC;IACf,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,YAAY,IAAqB,EAAE,GAAU,EAAE,OAAe;QAC5D,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAEf,mEAAmE;QACnE,6CAA6C;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,GAAG,UAAU,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,IAAI,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAE9H,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAkB,CAAC;YACrC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAsB,EAAE,EAAE;YAC5D,IAAI,CAAC,MAAM;gBACT,MAAM,KAAK,WAAW;oBACpB,CAAC,CAAC,WAAW;oBACb,CAAC,CAAC,MAAM,KAAK,cAAc;wBACzB,CAAC,CAAC,cAAc;wBAChB,CAAC,CAAC,YAAY,CAAC;YACrB,qEAAqE;YACrE,kEAAkE;YAClE,mEAAmE;YACnE,8DAA8D;YAC9D,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW;gBAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACrD,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,oEAAoE;QACpE,yEAAyE;QACzE,uEAAuE;QACvE,6CAA6C;QAC7C,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE;YAC3D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,IAAI;QACV,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS;YAAE,QAAQ,EAAE,CAAC;IACpD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,SAAS,CAAC,QAAwB;QAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO;QACL,KAAK,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;CACF"}
@@ -62,6 +62,14 @@ export interface CollabTransport {
62
62
  /** Hocuspocus expõe Awareness | null; partykit sempre não-null. */
63
63
  readonly awareness?: AwarenessProtocol.Awareness | null;
64
64
  getStatus(): CollabStatus;
65
+ /**
66
+ * True once the server's initial state has been applied to the doc.
67
+ *
68
+ * Optional: `getStatus() === 'connected'` only says the socket is open.
69
+ * Transports that can tell the two apart (Hocuspocus) implement this;
70
+ * for the others the session falls back to the status.
71
+ */
72
+ isSynced?(): boolean;
65
73
  /** Assina mudanças de status; retorna unsubscribe. */
66
74
  subscribe(listener: () => void): () => void;
67
75
  destroy(): void;
@@ -70,8 +78,11 @@ export interface CollabTransport {
70
78
  export type TransportFactory = (info: CollabTokenInfo, doc: Y.Doc, docName: string) => CollabTransport;
71
79
  /** Config global do client (props do <CollaborationProvider>). */
72
80
  export interface CollaborationClientConfig {
73
- /** Base URL do server Adonis (ex.: https://api.app). */
74
- baseUrl: string;
81
+ /**
82
+ * Base URL do server Adonis (ex.: https://api.app). Opcional: quando
83
+ * omitida o client usa `location.origin`, que é o caso same-origin.
84
+ */
85
+ baseUrl?: string | undefined;
75
86
  /**
76
87
  * Headers anexados às chamadas REST (ex.: cookie/token de sessão).
77
88
  * Função pra suportar tokens que rotacionam.
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,KAAK,iBAAiB,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC;AAE9B,qDAAqD;AACrD,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAC;AAEjF,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EACF;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,GACxE;QAAE,IAAI,EAAE,eAAe,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAChF;QAAE,IAAI,EAAE,WAAW,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,iEAAiE;AACjE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,4DAA4D;AAC5D,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC;IACpB,mEAAmE;IACnE,QAAQ,CAAC,SAAS,CAAC,EAAE,iBAAiB,CAAC,SAAS,GAAG,IAAI,CAAC;IACxD,SAAS,IAAI,YAAY,CAAC;IAC1B,sDAAsD;IACtD,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IAC5C,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,qEAAqE;AACrE,MAAM,MAAM,gBAAgB,GAAG,CAC7B,IAAI,EAAE,eAAe,EACrB,GAAG,EAAE,CAAC,CAAC,GAAG,EACV,OAAO,EAAE,MAAM,KACZ,eAAe,CAAC;AAErB,kEAAkE;AAClE,MAAM,WAAW,yBAAyB;IACxC,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5E,+DAA+D;IAC/D,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,KAAK,iBAAiB,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC;AAE9B,qDAAqD;AACrD,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAC;AAEjF,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EACF;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,GACxE;QAAE,IAAI,EAAE,eAAe,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAChF;QAAE,IAAI,EAAE,WAAW,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,iEAAiE;AACjE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,4DAA4D;AAC5D,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC;IACpB,mEAAmE;IACnE,QAAQ,CAAC,SAAS,CAAC,EAAE,iBAAiB,CAAC,SAAS,GAAG,IAAI,CAAC;IACxD,SAAS,IAAI,YAAY,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC;IACrB,sDAAsD;IACtD,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IAC5C,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,qEAAqE;AACrE,MAAM,MAAM,gBAAgB,GAAG,CAC7B,IAAI,EAAE,eAAe,EACrB,GAAG,EAAE,CAAC,CAAC,GAAG,EACV,OAAO,EAAE,MAAM,KACZ,eAAe,CAAC;AAErB,kEAAkE;AAClE,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5E,+DAA+D;IAC/D,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adonis-agora/collaboration-client",
3
- "version": "0.6.1",
3
+ "version": "0.7.1",
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": {
@@ -39,6 +39,9 @@
39
39
  "peerDependenciesMeta": {
40
40
  "react": {
41
41
  "optional": true
42
+ },
43
+ "@excalidraw/excalidraw": {
44
+ "optional": true
42
45
  }
43
46
  },
44
47
  "devDependencies": {