@iebh/tera-fy 2.3.11 → 2.3.12

package/lib/syncro/{syncro.ts → syncro.js}

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-unused-vars */
 import {
 	isEmpty,
@@ -14,41 +13,12 @@ import {
 	onSnapshot as FirestoreOnSnapshot,
 	setDoc as FirestoreSetDoc,
 	updateDoc as FirestoreUpdateDoc,
-	DocumentReference,
-	Firestore,
-	Unsubscribe,
 } from 'firebase/firestore';
-// @ts-expect-error No declaration file for marshal
 import marshal from '@momsfriendlydevco/marshal';
 import {nanoid} from 'nanoid';
 import PromiseThrottle from 'p-throttle';
 import PromiseRetry from 'p-retry';
-import {FirebaseApp, FirebaseError} from 'firebase/app';
-import { BoundSupabaseyFunction } from '@iebh/supabasey';
-import type { PostgresSql } from './entities.js';
-
-interface ThrottleOptions<T = any> {
-	limit: number,
-	interval: number,
-	strict: boolean,
-}
-
-interface ReactiveWrapper<T = any> {
-	doc: T;
-	setState: (newState: T) => void;
-	getState: () => T;
-	watch: (cb: (newState: T) => void) => void;
-	throttle?: ThrottleOptions | true,
-}
-
-interface PathSplitResult {
-	fsCollection: string;
-	fsId: string;
-	entity: string;
-	id: string;
-	relation?: string;
-}
-
+import {FirebaseError} from 'firebase/app';
 
 /**
 * @class Syncro
@@ -63,7 +33,7 @@ export default class Syncro {
 	*
 	* @type {FirebaseApp}
 	*/
-	static firebase: FirebaseApp;
+	static firebase;
 
 
 	/**
@@ -71,7 +41,7 @@ export default class Syncro {
 	*
 	* @type {Firestore}
 	*/
-	static firestore: Firestore;
+	static firestore;
 
 
 	/**
@@ -79,15 +49,15 @@ export default class Syncro {
 	*
 	* @type {Supabasey}
 	*/
-	static supabasey: BoundSupabaseyFunction;
+	static supabasey;
 
 
 	/**
 	* Postgres SQL instance in use (injected by the Cloudflare Worker runtime via Hyperdrive)
 	*
-	* @type {PostgresSql}
+	* @type {Object}
 	*/
-	static db: PostgresSql;
+	static db;
 
 
 	/**
@@ -96,16 +66,16 @@ export default class Syncro {
 	*
 	* @type {String}
 	*/
-	static session: string | undefined;
+	static session;
 
 
 	/**
-	* OPTIONAL SyncroEntries from './entities.ts' if its required
+	* OPTIONAL SyncroEntries from './entities.js' if its required
 	* This only gets populated if `config.forceLocalInit` is truthy and we've mounted at least one Syncro
 	*
-	* @type {Record<string, any>}
+	* @type {Object}
 	*/
-	static SyncroEntities: Record<string, any>;
+	static SyncroEntities;
 
 
 	/**
@@ -113,15 +83,15 @@ export default class Syncro {
 	*
 	* @type {String}
 	*/
-	path: string;
+	path;
 
 
 	/**
 	* The Firestore docHandle when calling various Firestore functions
 	*
-	* @type {DocumentReference | undefined}
+	* @type {DocumentReference}
 	*/
-	docRef: DocumentReference | undefined;
+	docRef;
 
 
 	/**
@@ -130,7 +100,7 @@ export default class Syncro {
 	*
 	* @type {any}
 	*/
-	value: any;
+	value;
 
 
 	/**
@@ -150,9 +120,9 @@ export default class Syncro {
 	* @property {Object} context Additional named parameters to pass to callbacks like initState
 	*/
 	config = {
-		heartbeatInterval: 120_000 as number, //~= 120s / 2m
-		syncroRegistryUrl: 'https://tera-tools.com/api/sync' as string,
-		context: {} as Record<string, any>,
+		heartbeatInterval: 300_000, //~= 300s / 5m
+		syncroRegistryUrl: 'https://tera-tools.com/api/sync',
+		context: {},
 	};
 
 
@@ -172,9 +142,9 @@ export default class Syncro {
 	* Debugging printer for this instance
 	* Defaults to doing nothing
 	*
-	* @param {*...} [msg] The message to output
+	* @param {...*} [msg] The message to output
 	*/
-	debug(...msg: any[]) {}
+	debug(...msg) {}
 
 
 	/**
@@ -182,9 +152,9 @@ export default class Syncro {
 	* Debugging printer specifically for error messages
 	* Defaults to using console.log()
 	*
-	* @param {*...} [msg] The message to output
+	* @param {...*} [msg] The message to output
 	*/
-	debugError(...msg: any[]) {
+	debugError(...msg) {
 		console.warn(`[Syncro ${this.path}]`, ...msg);
 	}
 
@@ -195,7 +165,7 @@ export default class Syncro {
 	* @param {String} path Mount path for the Syncro. Should be in the form `${ENTITY}::${ID}(::${RELATION})?`
 	* @param {Object} [options] Additional instance setters (mutates instance directly), note that the `config` subkey is merged with the existing config rather than assigned
 	*/
-	constructor(path: string, options?: any) {
+	constructor(path, options) {
 		this.path = path;
 		Object.assign(this, {
 			...options,
@@ -216,7 +186,7 @@ export default class Syncro {
 	*
 	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
-	destroy(): Promise<any[]> {
+	destroy() {
 		this.debug('Destroy!');
 		return Promise.resolve()
 			.then(()=> Promise.all(this._destroyActions // eslint-disable @typescript-eslint/await-thenable
@@ -230,9 +200,9 @@ export default class Syncro {
 	* Actions to preform when we are destroying this instance
 	* This is an array of function callbacks to execute in parallel when `destroy()` is called
 	*
-	* @type {Array<Function<Promise>>}
+	* @type {Array<Function>}
 	*/
-	_destroyActions: Array<() => void> = [];
+	_destroyActions = [];
 
 
 	/**
@@ -241,18 +211,18 @@ export default class Syncro {
 	*
 	* @param {Object} value Initial value of the reactive
 	*
-	* @returns {ReactiveWrapper} A reactive object prototype
+	* @returns {Object} A reactive object prototype
 	* @property {Object} doc The reactive object
 	* @property {Function} setState Function used to overwrite the default state, called as `(newState:Object)`
 	* @property {Function} getState Function used to fetch the current snapshot state, called as `()`
 	* @property {Function} watch Function used to set up state watchers, should call its callback when a change is detected, called as `(cb:Function)`
 	*/
-	getReactive(value: any): ReactiveWrapper {
+	getReactive(value) {
 		console.warn('Syncro.getReactive has not been subclassed, assuming a POJO response');
-		const doc: Record<string, any> = {...value};
+		const doc = {...value};
 		return {
 			doc,
-			setState(state: any) {
+			setState(state) {
 				// Shallow copy all sub keys into existing object (keeping the object pointer)
 				Object.entries(state || {})
 					.forEach(([k, v]) => doc[k] = v)
@@ -260,7 +230,7 @@ export default class Syncro {
 			getState() {
 				return cloneDeep(doc);
 			},
-			watch(cb: (newState: any) => void) {
+			watch(cb) {
 				// Stub
 			},
 		};
@@ -279,9 +249,10 @@ export default class Syncro {
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Boolean} [options.allowAsterisk=false] Whether to allow the meta asterisk character when recognising paths, this is used by the SyncroKeyed class
 	*
-	* @returns {PathSplitResult} An object composed of the session path components
+	* @returns {Object} An object composed of the session path components
 	*/
-	static pathSplit(path: string, options?: any): PathSplitResult {
+	static pathSplit(path, options) {
+		/* eslint-disable @stylistic/indent-binary-ops */
 		const settings = {
 			allowAsterisk: false,
 			...options,
@@ -301,7 +272,7 @@ export default class Syncro {
 			+ '$'
 		);
 
-		const extracted = { ...pathMatcher.exec(path)?.groups } as { entity?: string, id?: string, relation?: string };
+		const extracted = {...pathMatcher.exec(path)?.groups};
 
 		if (!extracted || !extracted.entity || !extracted.id) throw new Error(`Invalid session path syntax "${path}"`);
 		if (Syncro.SyncroEntities && !(extracted.entity in Syncro.SyncroEntities)) throw new Error(`Unsupported entity "${path}" -> Entity="${extracted.entity}"`);
@@ -325,10 +296,10 @@ export default class Syncro {
 	* 1. Arrays are converted to Objects (Firestore cannot store nested arrays)
 	* 2. All non-POJO objects (e.g. Dates) to a symmetric object
 	*
-	* @param {Object} snapshot The current state to convert
+	* @param {Object} [snapshot={}] The current state to convert
 	* @returns {Object} A Firebase compatible object
 	*/
-	static toFirestore(snapshot: any = {}): any {
+	static toFirestore(snapshot = {}) {
 		return marshal.serialize(snapshot, {
 			...marshalBaseConfig,
 			stringify: false,
@@ -340,10 +311,10 @@ export default class Syncro {
 	* Convert local Firestore compatible object -> local POJO
 	* This reverses the mutations listed in `toFirestore()`
 	*
-	* @param {Object} snapshot The raw Firebase state to convert
+	* @param {Object} [snapshot={}] The raw Firebase state to convert
 	* @returns {Object} A JavaScript POJO representing the converted state
 	*/
-	static fromFirestore(snapshot: any = {}): any {
+	static fromFirestore(snapshot = {}) {
 		return marshal.deserialize(snapshot, {
 			...marshalBaseConfig,
 			destringify: false,
@@ -360,28 +331,28 @@ export default class Syncro {
 	* @param {Object} data The raw value to convert
 	* @returns {Object} A Firestore compatible, typed data structure
 	*/
-	static toFirestoreFields(data: any): Record<string, any> {
-		const result: Record<string, any> = {};
+	static toFirestoreFields(data) {
+		const result = {};
 
 		for (const [key, value] of Object.entries(data)) {
 			const type = typeof value;
 
 			if (type === 'string') { // eslint-disable-line unicorn/prefer-switch
-				result[key] = { stringValue: value };
+				result[key] = {stringValue: value};
 			} else if (type === 'number') {
-				result[key] = { doubleValue: value };
+				result[key] = {doubleValue: value};
 			} else if (type === 'boolean') {
-				result[key] = { booleanValue: value };
+				result[key] = {booleanValue: value};
 			} else if (value === null) {
-				result[key] = { nullValue: null };
+				result[key] = {nullValue: null};
 			} else if (Array.isArray(value)) {
 				// Need to handle the inner item structure correctly
-				result[key] = { arrayValue: { values: value.map(item => {
-					const field = Syncro.toFirestoreFields({ item });
+				result[key] = {arrayValue: {values: value.map(item => {
+					const field = Syncro.toFirestoreFields({item});
 					return field.item; // Extract the typed value from the temporary {item: ...} structure
-				}) } };
+				})}};
 			} else if (type === 'object') {
-				result[key] = { mapValue: { fields: Syncro.toFirestoreFields(value) } };
+				result[key] = {mapValue: {fields: Syncro.toFirestoreFields(value)}};
 			}
 		}
 
@@ -395,11 +366,11 @@ export default class Syncro {
 	* NOTE: This does not deserialize the result so you likely want to use this as `fromFirestore(fromFirestoreFields(response.fields))`
 	*
 	* @see https://stackoverflow.com/a/62304377
-	* @param {Object} fields The raw Snapshot to convert
+	* @param {Object} [fields={}] The raw Snapshot to convert
 	* @returns {Object} A JavaScript POJO representing the converted state
 	*/
-	static fromFirestoreFields(fields: any = {}): any {
-		const result: Record<string, any> = {};
+	static fromFirestoreFields(fields = {}) {
+		const result = {};
 		for (const key in fields) {
 			const value = fields[key];
 			const isDocumentType = [
@@ -409,25 +380,22 @@ export default class Syncro {
 
 			if (isDocumentType) {
 				switch (isDocumentType) {
-				case 'mapValue':
-					result[key] = Syncro.fromFirestoreFields(value.mapValue.fields || {});
+					case 'mapValue':
+						result[key] = Syncro.fromFirestoreFields(value.mapValue.fields || {});
+						break;
 
-				break;
+					case 'arrayValue': {
+						const list = value.arrayValue.values;
+						result[key] = !!list ? list.map(l => Syncro.fromFirestoreFields(l)) : [];
 
-				case 'arrayValue': {
-					const list = value.arrayValue.values;
-					result[key] = !!list ? list.map((l: any) => Syncro.fromFirestoreFields(l)) : [];
-
-				break;
-				}
-				case 'nullValue':
-					result[key] = null;
-
-				break;
-
-				default:
-					result[key] = value[isDocumentType];
+						break;
+					}
+					case 'nullValue':
+						result[key] = null;
+						break;
 
+					default:
+						result[key] = value[isDocumentType];
 				}
 			} else {
 				// This case might not be standard Firestore field structure, but handle recursively
@@ -445,7 +413,7 @@ export default class Syncro {
 	*
 	* @returns {Promise<Object|Null>} An eventual snapshot of the given path, if the entity doesn't exist null is returned
 	*/
-	static getSnapshot(path: string): Promise<object | null> {
+	static getSnapshot(path) {
 		const {fsCollection, fsId} = Syncro.pathSplit(path);
 
 		return Promise.resolve()
@@ -470,7 +438,7 @@ export default class Syncro {
 	*
 	* @returns {Promise<*>} The state object after it has been applied
 	*/
-	static setSnapshot(path: string, state: any, options?: { method?: 'merge' | 'set' }): Promise<any> {
+	static setSnapshot(path, state, options) {
 		const settings = {
 			method: 'merge',
 			...options,
@@ -481,7 +449,7 @@ export default class Syncro {
 
 		return Promise.resolve()
 			.then(()=> {
-				if (settings.method === 'merge') {
+				if (settings.method === 'merge') { // eslint-disable-line unicorn/prefer-ternary
 					return FirestoreUpdateDoc(docRef, firestoreData);
 				} else { // method === 'set'
 					return FirestoreSetDoc(docRef, firestoreData); // Default set overwrites
@@ -499,7 +467,7 @@ export default class Syncro {
 	* @param {Number} [options.retries=3] Number of times to retry if a mounted Syncro fails its sanity checks
 	* @returns {Promise<Syncro>} A promise which resolves as this syncro instance when completed
 	*/
-	mount(options?: any): Promise<Syncro> {
+	mount(options) {
 		const settings = {
 			initialState: null,
 			retries: 5,
@@ -508,11 +476,11 @@ export default class Syncro {
 		};
 
 		const {fsCollection, fsId, entity} = Syncro.pathSplit(this.path);
-		let reactive: ReactiveWrapper; // Eventual response from reactive() with the initial value
-		let doc: any; // Eventual Firebase document
+		let reactive; // Eventual response from reactive() with the initial value
+		let doc; // Eventual Firebase document
 
 		return PromiseRetry(
-			async (): Promise<Syncro> => {
+			async () => {
 				await this.setHeartbeat(false); // Disable any existing heartbeat
 
 				// Set up binding and wait for it to come ready
@@ -572,7 +540,7 @@ export default class Syncro {
 				this.debug('Initial state', {doc});
 
 				// Subscribe to remote updates
-				const unsubscribe: Unsubscribe = FirestoreOnSnapshot(this.docRef, snapshot => {
+				const unsubscribe = FirestoreOnSnapshot(this.docRef, snapshot => {
 					const snapshotData = Syncro.fromFirestore(snapshot.data());
 					this.debug('Incoming snapshot', {snapshotData});
 					reactive.setState(snapshotData);
@@ -595,10 +563,10 @@ export default class Syncro {
 				}
 
 				// Setup local state watcher
-				reactive.watch(throttle((newState: any) => {
+				reactive.watch(throttle(newState => {
 					this.debug('Local change', {newState});
 					this.markDirty();
-					this.setFirestoreState(newState, {method: 'merge'}); // eslint-disable-line @typescript-eslint/no-floating-promises
+					this.setFirestoreState(newState, {method: 'merge'});
 				}, this.throttle));
 
 				await this.setHeartbeat(true, {
@@ -612,11 +580,12 @@ export default class Syncro {
 				minTimeout: settings.retryMinTime,
 				randomize: true,
 				factor: 3,
-				onFailedAttempt: async (e: any) => {
+				onFailedAttempt: async e => {
 					this.debugError(`[Attempt ${e.attemptNumber}/${e.attemptNumber + e.retriesLeft - 1}] to mount syncro`, e);
 					await this.destroy();
 				},
 			},
+
 		);
 	}
 
@@ -635,13 +604,9 @@ export default class Syncro {
 	*
 	* @returns {Promise<Syncro>} A promise which resolves with this Syncro instance on completion
 	*/
-	async set(
-		key: string | object,
-		value: any,
-		options: { delta?: boolean, flush?: boolean, forceFlush?: boolean, flushDestroy?: boolean }
-	) {
+	async set(key, value, options) {
 		// Argument mangling - [key, value, settings] -> changes{}, settings {{{
-		let changes: any;
+		let changes;
 		if (typeof key == 'string') { // Called as (key:String, value:*, options?:Object)
 			changes[key] = value;
 		} else if (typeof key == 'object') { // Called as (changes:Object, options?:Object)
@@ -684,6 +649,7 @@ export default class Syncro {
 		return this;
 	}
 
+
 	/**
 	* Schedule Syncro heartbeats
 	* This populates the `sync` presence meta-information
@@ -692,9 +658,9 @@ export default class Syncro {
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Boolean} [options.immediate=false] Fire a heartbeat as soon as this function is called, this is only really useful on mount
-	* @returns {Promise|Void} A promise that resolves when completed (if `{immediate:true}`) or void
+	* @returns {Promise} A promise that resolves when completed (if `{immediate:true}`) or just returns void
 	*/
-	setHeartbeat(enable: boolean = true, options?: any): Promise<void> | void {
+	setHeartbeat(enable = true, options) {
 		const settings = {
 			immediate: true,
 			...options,
@@ -709,13 +675,14 @@ export default class Syncro {
 				await this.heartbeat();
 
 				// If we're enabled - schedule the next heartbeat timer
-				if (enable) this.setHeartbeat(true); // eslint-disable-line @typescript-eslint/no-floating-promises
+				if (enable) this.setHeartbeat(true);
 			};
 
 			this._heartbeatTimer = setTimeout(heartbeatAction, this.config.heartbeatInterval);
 
 			if (settings.immediate) return this.heartbeat(); // Return the promise from immediate heartbeat
 		}
+		return Promise.resolve();
 	}
 
 
@@ -725,7 +692,7 @@ export default class Syncro {
 	*
 	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
-	async heartbeat(): Promise<void> {
+	async heartbeat() {
 		this.debug('heartbeat!');
 
 		try {
@@ -761,7 +728,7 @@ export default class Syncro {
 	* @param {number} retries How many tries to take before erroring
 	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
-	async setFirestoreState(state: any, options?: { method?: 'merge' | 'set' }, retries = 0): Promise<void> {
+	async setFirestoreState(state, options, retries = 0) {
 		const settings = {
 			method: 'merge',
 			...options,
@@ -771,7 +738,7 @@ export default class Syncro {
 		const firestoreData = Syncro.toFirestore(state);
 
 		try {
-			if (settings.method === 'merge') {
+			if (settings.method === 'merge') { // eslint-disable-line unicorn/prefer-ternary
 				return await FirestoreUpdateDoc(this.docRef, firestoreData);
 			} else { // method === 'set'
 				return await FirestoreSetDoc(this.docRef, firestoreData);
@@ -803,7 +770,7 @@ export default class Syncro {
 	*
 	* @returns {Promise<Object>} A promise which resolves to the Firestore state
 	*/
-	getFirestoreState(): Promise<any> {
+	getFirestoreState() {
 		if (!this.docRef) throw new Error('mount() must be called before getting Firestore state');
 
 		return FirestoreGetDoc(this.docRef)
@@ -817,7 +784,7 @@ export default class Syncro {
 	* @see isDirty
 	* @returns {Syncro} This chainable Syncro instance
 	*/
-	markDirty(): this {
+	markDirty() {
 		this.isDirty = true;
 		return this;
 	}
@@ -832,7 +799,7 @@ export default class Syncro {
 	*
 	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
-	flush(options?: any): Promise<void | null> {
+	flush(options) {
 		const settings = {
 			destroy: false,
 			...options,
@@ -849,9 +816,9 @@ export default class Syncro {
 	/**
 	* Timer handle for heartbeats
 	*
-	* @type {any}
+	* @type {*}
 	*/
-	_heartbeatTimer: any; // Using any for simplicity with NodeJS.Timeout / number
+	_heartbeatTimer;
 }
 
 
@@ -863,7 +830,8 @@ export default class Syncro {
 *
 * @returns {*} The current branch contents
 */
-export function randomBranch(depth: number = 0): any {
+export function randomBranch(depth = 0) {
+	/* eslint-disable @stylistic/indent */
 	const dice = // Roll a dice to pick the content
 		depth == 0 ? 10 // first roll is always '10'
 		: random(0, 11 - depth, false); // Subsequent rolls bias downwards based on depth (to avoid recursion)
@@ -873,12 +841,12 @@ export function randomBranch(depth: number = 0): any {
 		: dice == 1 ? true
 		: dice == 2 ? random(1, 10_000)
 		: dice == 3 ? (new Date(random(1_000_000_000_000, 1_777_777_777_777))).toISOString()
-		: dice == 5 ? Array.from({length: random(1, 10)}, (): number => random(1, 10)) // Added return type hint
+		: dice == 5 ? Array.from({length: random(1, 10)}, () => random(1, 10))
 		: dice == 6 ? null
-		: dice < 8 ? Array.from({length: random(1, 10)}, (): any => randomBranch(depth+1)) // Added return type hint
+		: dice < 8 ? Array.from({length: random(1, 10)}, () => randomBranch(depth+1))
 		: Object.fromEntries(
 			Array.from({length: random(1, 5)})
-				.map((v, k): [string, any] => [ // Added return type hint
+				.map((v, k) => [
 					sample(['foo', 'bar', 'baz', 'quz', 'flarp', 'corge', 'grault', 'garply', 'waldo', 'fred', 'plugh', 'thud'])
 					+ `_${k}`,
 					randomBranch(depth+1),
@@ -899,30 +867,30 @@ const marshalBaseConfig = {
 		{ // Flatten arrays into something Firebase can handle
 			id: `~array`,
 			recursive: true,
-			test: (v: any) => Array.isArray(v),
-			serialize: (v: any) => ({_: '~array', ...v}),
-			deserialize: (v: any) => {
+			test: v => Array.isArray(v),
+			serialize: v => ({_: '~array', ...v}),
+			deserialize: v => {
 				const arr = Array.from({length: Object.keys(v).length - 1});
 
 				Object.entries(v)
 					.filter(([k]) => k !== '_')
-					.forEach(([k, val]) => arr[+k] = val); // Changed v to val to avoid shadowing
+					.forEach(([k, val]) => arr[+k] = val);
 
 				return arr;
 			},
 		},
 		{ // Strip Functions during {,de-}serialization
 			id: '~function',
-			test: (v: any) => typeof v == 'function',
-			serialize: (v: any, path: string[]) => {
+			test: v => typeof v == 'function',
+			serialize: (v, path) => {
 				console.warn('Marshal Warning: Stripping function from path', path.join('.'));
 				throw new Error('Function serializing is forbidden');
 			},
-			deserialize: (v: any, path: string[]) => {
+			deserialize: (v, path) => {
 				console.warn('Marshal Warning: Stripping function from path', path.join('.'));
 			},
 		},
 		...marshal.settings.modules // Use default Marshal modules excepting...
-			.filter((mod: any) => mod.id != '~function') // Remove the Marshal function module as this upsets Cloudflare workers by using the `eval` built-in
+			.filter(mod => mod.id != '~function') // Remove the Marshal function module as this upsets Cloudflare workers by using the `eval` built-in
 	],
 };