@styris-ame/y-engineio 1.1.0

package/dist/y-engineio.d.ts

@@ -0,0 +1,135 @@
+export const messageSync: 0;
+export const messageQueryAwareness: 3;
+export const messageAwareness: 1;
+export const messageAuth: 2;
+/**
+ * Engine.IO Provider for Yjs. Creates an engine.io connection to sync the shared
+ * document. Unlike a raw WebSocket, engine.io connects to a single endpoint and
+ * has no document name in the URL, so the room name is sent as the `room`
+ * handshake query parameter, letting the server accept or reject the connection
+ * before any sync frames are exchanged.
+ *
+ * @example
+ *   import * as Y from 'yjs'
+ *   import { EngineIOProvider } from '@styris-ame/y-engineio'
+ *   const doc = new Y.Doc()
+ *   const provider = new EngineIOProvider('http://localhost:1234', 'my-document-name', doc)
+ *
+ * @extends {ObservableV2<{ 'connection-close': (event: any,  provider: EngineIOProvider) => any, 'status': (event: { status: 'connected' | 'disconnected' | 'connecting' }) => any, 'connection-error': (event: any, provider: EngineIOProvider) => any, 'sync': (state: boolean) => any, 'synced': (state: boolean) => any }>}
+ */
+export class EngineIOProvider extends ObservableV2<{
+    'connection-close': (event: any, provider: EngineIOProvider) => any;
+    status: (event: {
+        status: "connected" | "disconnected" | "connecting";
+    }) => any;
+    'connection-error': (event: any, provider: EngineIOProvider) => any;
+    sync: (state: boolean) => any;
+    synced: (state: boolean) => any;
+}> {
+    /**
+     * @param {string} serverUrl engine.io server origin, e.g. 'http://localhost:1234'
+     * @param {string} roomname
+     * @param {Y.Doc} doc
+     * @param {object} opts
+     * @param {boolean} [opts.connect]
+     * @param {awarenessProtocol.Awareness} [opts.awareness]
+     * @param {Object<string,string>} [opts.params] url query params, passed to engine.io as `query`
+     * @param {object} [opts.engineOptions] options forwarded to the engine.io-client `Socket` (e.g. `path`, `transports`, `withCredentials`, `extraHeaders`)
+     * @param {typeof Engine} [opts.EngineClass] override the engine.io `Socket` constructor (e.g. for testing)
+     * @param {number} [opts.resyncInterval] Request server state every `resyncInterval` milliseconds
+     * @param {number} [opts.maxBackoffTime] Maximum amount of time to wait before trying to reconnect (we try to reconnect using exponential backoff)
+     * @param {boolean} [opts.disableBc] Disable cross-tab BroadcastChannel communication
+     */
+    constructor(serverUrl: string, roomname: string, doc: Y.Doc, { connect, awareness, params, engineOptions, EngineClass, resyncInterval, maxBackoffTime, disableBc }?: {
+        connect?: boolean | undefined;
+        awareness?: awarenessProtocol.Awareness | undefined;
+        params?: {
+            [x: string]: string;
+        } | undefined;
+        engineOptions?: object | undefined;
+        EngineClass?: typeof Engine | undefined;
+        resyncInterval?: number | undefined;
+        maxBackoffTime?: number | undefined;
+        disableBc?: boolean | undefined;
+    });
+    serverUrl: string;
+    bcChannel: string;
+    maxBackoffTime: number;
+    /**
+     * The specified url parameters. This can be safely updated. The changed parameters will be used
+     * when a new connection is established.
+     * @type {Object<string,string>}
+     */
+    params: {
+        [x: string]: string;
+    };
+    /**
+     * Options forwarded verbatim to the engine.io-client `Socket`.
+     * @type {object}
+     */
+    engineOptions: object;
+    roomname: string;
+    doc: Y.Doc;
+    _Engine: typeof Engine;
+    awareness: awarenessProtocol.Awareness;
+    connected: boolean;
+    connecting: boolean;
+    bcconnected: boolean;
+    disableBc: boolean;
+    unsuccessfulReconnects: number;
+    messageHandlers: ((arg0: encoding.Encoder, arg1: decoding.Decoder, arg2: EngineIOProvider, arg3: boolean, arg4: number) => void)[];
+    /**
+     * @type {boolean}
+     */
+    _synced: boolean;
+    /**
+     * The engine.io-client `Socket`, or null when disconnected.
+     * @type {Engine?}
+     */
+    engine: Engine | null;
+    lastMessageReceived: number;
+    /**
+     * Whether to connect to other peers or not
+     * @type {boolean}
+     */
+    shouldConnect: boolean;
+    /**
+     * @type {number}
+     */
+    _resyncInterval: number;
+    /**
+     * @param {ArrayBuffer} data
+     * @param {any} origin
+     */
+    _bcSubscriber: (data: ArrayBuffer, origin: any) => void;
+    /**
+     * Listens to Yjs updates and sends them to remote peers (engine.io and broadcastchannel)
+     * @param {Uint8Array} update
+     * @param {any} origin
+     */
+    _updateHandler: (update: Uint8Array, origin: any) => void;
+    /**
+     * @param {any} changed
+     * @param {any} _origin
+     */
+    _awarenessUpdateHandler: ({ added, updated, removed }: any, _origin: any) => void;
+    _exitHandler: () => void;
+    _checkInterval: any;
+    get url(): string;
+    set synced(state: boolean);
+    /**
+     * @type {boolean}
+     */
+    get synced(): boolean;
+    connectBc(): void;
+    disconnectBc(): void;
+    disconnect(): void;
+    connect(): void;
+}
+import { ObservableV2 } from 'lib0/observable';
+import * as Y from 'yjs';
+import { Socket as Engine } from 'engine.io-client';
+import * as awarenessProtocol from 'y-protocols/awareness';
+import * as encoding from 'lib0/encoding';
+import * as decoding from 'lib0/decoding';
+//# sourceMappingURL=y-engineio.d.ts.map

package/dist/y-engineio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"y-engineio.d.ts","sourceRoot":"","sources":["../src/y-engineio.js"],"names":[],"mappings":"AAmBA,0BAA2B,CAAC,CAAA;AAC5B,oCAAqC,CAAC,CAAA;AACtC,+BAAgC,CAAC,CAAA;AACjC,0BAA2B,CAAC,CAAA;AA6P5B;;;;;;;;;;;;;;GAcG;AACH;wBAFgD,CAAC,KAAK,EAAE,GAAG,EAAG,QAAQ,EAAE,gBAAgB,KAAK,GAAG;YAAY,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,WAAW,GAAG,cAAc,GAAG,YAAY,CAAA;KAAE,KAAK,GAAG;wBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,KAAK,GAAG;UAAU,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG;YAAY,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG;;IAG1T;;;;;;;;;;;;;OAaG;IACH,uBAbW,MAAM,YACN,MAAM,OACN,CAAC,CAAC,GAAG,0GAEb;QAAuB,OAAO;QACa,SAAS;QACf,MAAM;;;QACrB,aAAa;QACN,WAAW;QAClB,cAAc;QACd,cAAc;QACb,SAAS;KAClC,EAyIA;IAzHC,kBAA0B;IAC1B,kBAA2C;IAC3C,uBAAoC;IACpC;;;;OAIG;IACH;;MAAoB;IACpB;;;OAGG;IACH,eAFU,MAAM,CAEkB;IAClC,iBAAwB;IACxB,WAAc;IACd,uBAA0B;IAC1B,uCAA0B;IAC1B,mBAAsB;IACtB,oBAAuB;IACvB,qBAAwB;IACxB,mBAA0B;IAC1B,+BAA+B;IAC/B,yBA7TqB,QAAQ,CAAC,OAAO,QAAE,QAAQ,CAAC,OAAO,QAAE,gBAAgB,QAAE,OAAO,QAAK,MAAM,KAAE,IAAI,IA6TrD;IAC9C;;OAEG;IACH,SAFU,OAAO,CAEG;IACpB;;;OAGG;IACH,QAFU,MAAM,OAAC,CAEC;IAClB,4BAA4B;IAC5B;;;OAGG;IACH,eAFU,OAAO,CAEW;IAE5B;;OAEG;IACH,iBAFU,MAAM,CAEQ;IAaxB;;;OAGG;IACH,sBAHW,WAAW,UACX,GAAG,UASb;IACD;;;;OAIG;IACH,yBAHW,UAAU,UACV,GAAG,UASb;IAED;;;OAGG;IACH,uDAHW,GAAG,WACH,GAAG,UAWb;IACD,yBAMC;IAKD,oBAUiC;IAMnC,kBAGC;IASD,kBANU,OAAO,EAahB;IAdD;;OAEG;IACH,cAFU,OAAO,CAIhB;IAyBD,kBAyCC;IAED,qBAeC;IAED,mBAMC;IAED,gBAMC;CACF;6BA5hB4B,iBAAiB;mBAR3B,KAAK;iCAYS,kBAAkB;mCALhB,uBAAuB;0BAJhC,eAAe;0BACf,eAAe"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@styris-ame/y-engineio",
+  "version": "1.1.0",
+  "description": "Engine.IO provider for Yjs (Yjs v13 line)",
+  "main": "./dist/y-engineio.cjs",
+  "module": "./src/y-engineio.js",
+  "types": "./dist/y-engineio.d.ts",
+  "type": "module",
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rm -rf dist",
+    "dist": "npm run clean && rollup -c && tsc --skipLibCheck",
+    "lint": "standard && tsc --skipLibCheck",
+    "test": "node ./test/index.js",
+    "preversion": "npm run dist && test -e dist/y-engineio.d.ts && test -e dist/y-engineio.cjs"
+  },
+  "files": [
+    "dist/*",
+    "src/*"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./src/y-engineio.js",
+      "import": "./src/y-engineio.js",
+      "require": "./dist/y-engineio.cjs",
+      "types": "./dist/y-engineio.d.ts",
+      "default": "./src/y-engineio.js"
+    }
+  },
+  "keywords": [
+    "Yjs",
+    "engine.io"
+  ],
+  "license": "MIT",
+  "standard": {
+    "ignore": [
+      "/dist",
+      "/node_modules"
+    ]
+  },
+  "dependencies": {
+    "engine.io-client": "^6.6.5",
+    "lib0": "^0.2.99",
+    "y-protocols": "^1.0.6"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.0",
+    "rollup": "^4.43.0",
+    "standard": "^17.1.2",
+    "typescript": "^5.8.3",
+    "yjs": "^13.6.0"
+  },
+  "peerDependencies": {
+    "yjs": "^13.6.0"
+  },
+  "engines": {
+    "npm": ">=8.0.0",
+    "node": ">=16.0.0"
+  }
+}