@eweser/db
Version:
eweser-db core database
254 lines • 11.3 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Database = void 0;
const room_1 = require("./room");
const types_1 = require("./types");
const events_1 = require("./events");
const shared_1 = require("@eweser/shared");
const getDocuments_1 = require("./utils/getDocuments");
const serverFetch_1 = require("./utils/connection/serverFetch");
const logout_1 = require("./methods/connection/logout");
const login_1 = require("./methods/connection/login");
const log_1 = require("./methods/log");
const generateLoginUrl_1 = require("./methods/connection/generateLoginUrl");
const getAccessGrantTokenFromUrl_1 = require("./methods/connection/getAccessGrantTokenFromUrl");
const getToken_1 = require("./methods/connection/getToken");
const getRegistry_1 = require("./methods/getRegistry");
const loadRoom_1 = require("./methods/connection/loadRoom");
const refreshYSweetToken_1 = require("./methods/connection/refreshYSweetToken");
const syncRegistry_1 = require("./methods/connection/syncRegistry");
const loadRooms_1 = require("./methods/connection/loadRooms");
const localStorageService_1 = require("./utils/localStorageService");
const generateShareRoomLink_1 = require("./methods/connection/generateShareRoomLink");
const pingServer_1 = require("./utils/connection/pingServer");
const pollConnection_1 = require("./utils/connection/pollConnection");
const newRoom_1 = require("./methods/newRoom");
__exportStar(require("./utils"), exports);
__exportStar(require("./types"), exports);
const defaultRtcPeers = [
'wss://signaling.yjs.debv',
'wss://y-webrtc-signaling-eu.herokuapp.com',
'wss://y-webrtc-signaling-us.herokuapp.com',
];
class Database extends events_1.TypedEventEmitter {
userId = '';
/* default to the eweser auth server https://www.eweser.com */
authServer = 'https://www.eweser.com';
online = false;
isPolling = false;
offlineOnly = false;
/** these rooms will be synced for one second and then disconnected sequentially. Remove the id from this array and the next iteration will not sync that room when it reaches it*/
collectionKeysForRollingSync = [];
/** set to false before `db.loginWithToken()` so that offline-first mode is the default, and it upgrades to online sync after login with token */
useYSweet = false;
useWebRTC = true;
useIndexedDB = true;
indexedDBProviderPolyfill;
collectionKeys = shared_1.collectionKeys;
collections = types_1.collections;
registry = [];
accessGrantToken = '';
webRtcPeers = defaultRtcPeers;
// METHODS
// logger/event emitter
logLevel = 2;
log = (0, log_1.log)(this);
debug = (...message) => this.log(0, ...message);
info = (...message) => this.log(1, ...message);
warn = (...message) => this.log(2, ...message);
error = (...message) => this.log(3, message);
// CONNECT METHODS
serverFetch = (0, serverFetch_1.serverFetch)(this);
generateLoginUrl = (0, generateLoginUrl_1.generateLoginUrl)(this);
login = (0, login_1.login)(this);
logout = (0, logout_1.logout)(this);
logoutAndClear = (0, logout_1.logoutAndClear)(this);
getAccessGrantTokenFromUrl = (0, getAccessGrantTokenFromUrl_1.getAccessGrantTokenFromUrl)(this);
getToken = (0, getToken_1.getToken)(this);
refreshYSweetToken = (0, refreshYSweetToken_1.refreshYSweetToken)(this);
/** first loads the local indexedDB ydoc for the room. if this.useYSweet is true and ySweetTokens are available will also connect to remote.
* @param {RemoteLoadOptions} RemoteLoadOptions - options for loading the remote ydoc
*/
loadRoom = (0, loadRoom_1.loadRoom)(this);
loadRooms = (0, loadRooms_1.loadRooms)(this);
syncRegistry = (0, syncRegistry_1.syncRegistry)(this);
// util methods
getRegistry = (0, getRegistry_1.getRegistry)(this);
localStoragePolyfill;
localStorageService = {
setItem: (0, localStorageService_1.localStorageSet)(this),
getItem: (0, localStorageService_1.localStorageGet)(this),
removeItem: (0, localStorageService_1.localStorageRemove)(this),
};
// collection methods
getDocuments = (0, getDocuments_1.getDocuments)(this);
getRoom = (collectionKey, roomId) => {
return this.collections[collectionKey][roomId];
};
getRooms(collectionKey) {
return Object.values(this.collections[collectionKey]);
}
allRooms() {
return Object.values(this.collections).flatMap((collection) => Object.values(collection));
}
newRoom = (0, newRoom_1.newRoom)(this);
renameRoom = async (room, newName) => {
const body = {
newName,
};
const { data, error } = await this.serverFetch(`/access-grant/update-room/${room.id}`, {
method: 'POST',
body,
});
if (error) {
this.error('Error renaming room', error);
}
else if (data?.name) {
room.name = data.name;
this.debug('Room renamed', data);
const registryEntry = this.registry.find((r) => r.id === room.id);
if (registryEntry) {
registryEntry.name = data.name;
(0, localStorageService_1.setLocalRegistry)(this)(this.registry);
}
else {
this.error('Error renaming room, registry entry not found');
}
}
return data;
};
generateShareRoomLink = (0, generateShareRoomLink_1.generateShareRoomLink)(this);
pingServer = (0, pingServer_1.pingServer)(this);
/** Because we can't have more than 10 rooms open (connected to ySweet) at one time, we can do a rollingSync of all rooms where we briefly connect them, one at a time, let them sync and then disconnect */
async rollingSync() {
while (true) {
console.log('--- rollingSync ---');
if (this.online) {
for (const key of this.collectionKeysForRollingSync) {
for (const room of this.getRooms(key)) {
console.log('rollingSync room', room.name, room.connectionStatus);
if (room.connectionStatus !== 'disconnected') {
console.log('rollingSync skipping room', key, room.name, room.connectionStatus);
continue;
}
console.log('rollingSync syncing room', key, room.name, room.connectionStatus);
room.disconnect();
await room.load({ loadRemote: true, awaitLoadRemote: true });
console.log('rollingSync room', room.name, room.connectionStatus);
await (0, shared_1.wait)(5000);
room.disconnect();
}
}
}
await (0, shared_1.wait)(5000);
}
}
statusListener() {
const allRooms = this.allRooms();
const connectedRooms = allRooms
.filter((r) => r.connectionStatus === 'connected')
.map((r) => r.id);
const connectingRooms = allRooms
.filter((r) => r.connectionStatus === 'connecting')
.map((r) => r.id);
this.emit('status', {
db: this,
online: this.online,
hasToken: !!this.accessGrantToken,
allRoomsCount: allRooms.length,
connectedRoomsCount: connectedRooms.length,
connectedRooms,
connectingRooms,
connectingRoomsCount: connectingRooms.length,
});
}
/** useful for debugging or less granular event listening */
pollForStatus(intervalMs = 1000) {
setInterval(() => {
this.statusListener();
}, intervalMs);
}
registrySyncIntervalMs = 10000;
pollForRegistrySync() {
setInterval(() => {
this.syncRegistry();
}, this.registrySyncIntervalMs);
}
constructor(optionsPassed) {
super();
if (optionsPassed?.pollForStatus) {
this.pollForStatus();
}
const options = optionsPassed || {};
this.localStoragePolyfill = options.localStoragePolyfill || localStorage;
if (options.authServer) {
this.authServer = options.authServer;
}
if (options.providers) {
if (!options.providers.includes('WebRTC')) {
this.webRtcPeers = [];
this.useWebRTC = false;
}
if (options.providers.includes('YSweet')) {
this.useYSweet = true;
}
if (!options.providers.includes('IndexedDB')) {
// need to have at least one provider, the local storage provider
throw new Error('IndexedDB provider is required');
// this.useIndexedDB = false;
}
}
if (options.providers?.length &&
options.providers?.length === 1 &&
options.providers[0] === 'IndexedDB') {
this.offlineOnly = true;
}
else {
(0, pollConnection_1.pollConnection)(this); // start polling for auth server connection status
if (options?.webRTCPeers) {
// note that webRtc is only for tempDocs because they are not secure/encrypted yet so we dont want to sync all our long lived yDocs (rooms) with the webRTC peers.
this.webRtcPeers = options?.webRTCPeers;
}
}
if (typeof options.logLevel === 'number') {
this.logLevel = options.logLevel;
}
(0, events_1.setupLogger)(this);
this.debug('Database created with options', options);
this.registry = this.getRegistry() || [];
let initializedRooms = [];
if (options.initialRooms) {
const registryRoomIds = this.registry.map((r) => r.id);
for (const room of options.initialRooms) {
const registryRoom = (0, room_1.roomToServerRoom)(this.newRoom(room));
if (room.id && !registryRoomIds.includes(room.id)) {
this.registry.push(registryRoom);
}
initializedRooms.push(registryRoom);
}
/** try to load remotes for initial rooms */
this.loadRooms(initializedRooms, true);
}
/** load all rooms in the registry locally */
this.loadRooms(this.registry);
this.pollForRegistrySync();
this.rollingSync();
this.emit('initialized');
}
}
exports.Database = Database;
//# sourceMappingURL=index.js.map