@adonis-agora/collaboration-client 0.2.0

package/dist/src/transports/partyserver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partyserver.js","sourceRoot":"","sources":["../../../src/transports/partyserver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAC;AAoC5D,MAAM,aAAa,GAChB,iBAA2F;KACzF,SAAS,IAAK,iBAA6D,CAAC,OAAO,CAAC;AAEzF,MAAM,OAAO,0BAA0B;IAC5B,GAAG,CAAQ;IACZ,QAAQ,CAAgC;IACxC,MAAM,GAAiB,YAAY,CAAC;IACpC,SAAS,GAAG,IAAI,GAAG,EAAc,CAAC;IAE1C,YAAY,IAAqB,EAAE,GAAU,EAAE,OAAe;QAC5D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAEf,gEAAgE;QAChE,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,KAAK,EAAE,EACpE,UAAU,CAAC,QAAQ,EAAE,MAAM,IAAI,mBAAmB,CACnD,CAAC;QAEF,MAAM,aAAa,GAAG,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjE,MAAM,KAAK,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,aAAa;YACxB,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;YACrE,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE;YACjF,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3B,QAAQ,EACN,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAE,IAAc,CAAC,CAAC,CAAE,KAAe;YACzF,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE;SAC9B,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,GAAG,EAAE;YAChB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS;gBAAE,QAAQ,EAAE,CAAC;QACpD,CAAC,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;YACjC,MAAM,GAAG,GAAI,GAAuC,EAAE,MAAM,CAAC;YAC7D,IAAI,CAAC,MAAM;gBACT,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,KAAK,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC;YAC7F,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;YACxC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;YACtB,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;YACxC,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC5B,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC;gBAC7B,IAAI,EAAE,CAAC;YACT,CAAC;QACH,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,QAAoB;QAC5B,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,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;CACF"}

package/dist/src/types.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Tipos do client. Cópias estruturais (types-only) dos contratos do server
+ * pra manter os pacotes independentes.
+ */
+import type * as AwarenessProtocol from 'y-protocols/awareness.js';
+import type * as Y from 'yjs';
+/** Estado da conexão WebSocket com o sync engine. */
+export type CollabStatus = 'connecting' | 'connected' | 'disconnected' | 'error';
+/** Resposta de GET /collaboration/token. */
+export interface CollabTokenInfo {
+    token: string;
+    /** URL do WS (self-hosted: path relativo; partykit: origin remoto). */
+    wsUrl: string;
+    /** Engine informado pelo server (yjs | automerge | partykit). */
+    engine: string;
+}
+/** Comentário persistido (espelho do CollabComment do server). */
+export interface CollabComment {
+    id: string;
+    documentName: string;
+    space: string;
+    anchor: {
+        kind: 'text-range';
+        start: number;
+        end: number;
+        selectedText: string;
+    } | {
+        kind: 'canvas-object';
+        shapeId: string;
+        relativeX: number;
+        relativeY: number;
+    } | {
+        kind: 'timestamp';
+        at: number;
+        end?: number;
+    };
+    body: string;
+    userId: string;
+    authorName?: string | null;
+    resolvedAt: string | null;
+    createdAt: string;
+    updatedAt: string | null;
+}
+/** Versão registrada no histórico (espelho do CollabVersion). */
+export interface CollabVersion {
+    id: string;
+    createdAt: string;
+    createdBy: string | null;
+    label: string | null;
+    seq: number;
+}
+/** Peer presente num documento (metadados de awareness). */
+export interface CollabPeer {
+    clientId: number;
+    userId?: string | undefined;
+    name?: string | undefined;
+    avatarUrl?: string | null;
+}
+/** Transporte mínimo sobre o engine escolhido pelo server. */
+export interface CollabTransport {
+    readonly doc: Y.Doc;
+    /** Hocuspocus expõe Awareness | null; partykit sempre não-null. */
+    readonly awareness?: AwarenessProtocol.Awareness | null;
+    getStatus(): CollabStatus;
+    /** Assina mudanças de status; retorna unsubscribe. */
+    subscribe(listener: () => void): () => void;
+    destroy(): void;
+}
+/** Factory de transporte — injetável pra testes e engines custom. */
+export type TransportFactory = (info: CollabTokenInfo, doc: Y.Doc, docName: string) => CollabTransport;
+/** Config global do client (props do <CollaborationProvider>). */
+export interface CollaborationClientConfig {
+    /** Base URL do server Adonis (ex.: https://api.app). */
+    baseUrl: string;
+    /**
+     * Headers anexados às chamadas REST (ex.: cookie/token de sessão).
+     * Função pra suportar tokens que rotacionam.
+     */
+    getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
+    /** Factory custom de transporte (tests / engines próprios). */
+    createTransport?: TransportFactory;
+    /** Override de fetch (testes/SSR). */
+    fetchImpl?: typeof fetch;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +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"}

package/dist/src/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@adonis-agora/collaboration-client",
+  "version": "0.2.0",
+  "description": "Client-side React hooks for @adonis-agora/collaboration — collaborative docs, presence, comments and versions. Part of the Agora ecosystem.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DavideCarvalho/adonis-agora-collaboration.git",
+    "directory": "packages/client"
+  },
+  "author": "Davi Carvalho <davi@goflip.ai>",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "pnpm run clean && tsc -p tsconfig.build.json",
+    "check:dist": "node ../../scripts/assert-build-output.mjs dist src/index.js",
+    "clean": "rm -rf dist",
+    "prepack": "pnpm run check:dist",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@automerge/automerge": "^3.4.1",
+    "@hocuspocus/provider": "^4.6.0",
+    "y-partykit": "^0.0.33",
+    "y-partyserver": "^2.2.0",
+    "y-protocols": "^1.0.7",
+    "yjs": "^13.6.27"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@swc/core": "1.15.47",
+    "@testing-library/react": "16.3.0",
+    "@types/node": "22.20.1",
+    "@types/react": "18.3.27",
+    "@types/react-dom": "18.3.7",
+    "jsdom": "26.1.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "typescript": "5.9.3",
+    "unplugin-swc": "1.5.11",
+    "vitest": "3.2.7"
+  },
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "keywords": [
+    "adonisjs",
+    "crdt",
+    "yjs",
+    "collaboration",
+    "realtime",
+    "react-hooks",
+    "agora"
+  ]
+}