@iebh/tera-fy 2.0.21 → 2.2.0

package/package.json

@@ -1,43 +1,73 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "2.0.21",
+  "version": "2.2.0",
   "description": "TERA website worker",
   "scripts": {
-    "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
+    "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.ts --outfile=dist/terafy.js --minify --serve --servedir=.",
     "build": "concurrently 'npm:build:*'",
-    "build:client": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify",
-    "build:client:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle lib/terafy.client.js --outfile=dist/terafy.es2019.js --minify",
-    "build:bootstrapper": "esbuild --platform=browser --format=esm --bundle lib/terafy.bootstrapper.js --outfile=dist/terafy.bootstrapper.js --minify",
-    "build:bootstrapper:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle lib/terafy.bootstrapper.js --outfile=dist/terafy.bootstrapper.es2019.js --minify",
-    "build:plugins:vue2:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle plugins/vue2.js --outfile=dist/plugin.vue2.es2019.js --minify",
-    "build:docs:api": "documentation build lib/terafy.client.js lib/projectFile.js --format html --config documentation.yml --output docs/",
-    "build:docs:markdown": "documentation build lib/terafy.client.js lib/projectFile.js --format md --markdown-toc --output api.md",
-    "lint": "eslint lib plugins utils widgets",
+    "build:tsc": "tsc --outDir dist",
+    "build:client": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.ts --outfile=dist/terafy.js --minify",
+    "build:client:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle lib/terafy.client.ts --outfile=dist/terafy.es2019.js --minify",
+    "build:bootstrapper": "esbuild --platform=browser --format=esm --bundle lib/terafy.bootstrapper.ts --outfile=dist/terafy.bootstrapper.js --minify",
+    "build:bootstrapper:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle lib/terafy.bootstrapper.ts --outfile=dist/terafy.bootstrapper.es2019.js --minify",
+    "build:plugins:vue2:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle plugins/vue2.ts --outfile=dist/plugin.vue2.es2019.js --minify",
+    "build:docs:api": "documentation build lib/terafy.client.ts lib/projectFile.ts --format html --config documentation.yml --output docs/",
+    "build:docs:markdown": "documentation build lib/terafy.client.ts lib/projectFile.ts --format md --markdown-toc --output api.md",
+    "lint": "eslint lib plugins utils widgets --ext .ts",
     "release": "release-it",
-    "watch": "nodemon --watch lib --watch plugins --exec npm run build"
+    "watch": "nodemon --watch lib --watch plugins --exec \"npm run build\""
   },
   "type": "module",
   "imports": {
-    "#terafy": "./lib/terafy.client.js",
-    "#utils/*": "./utils/*.js"
+    "#terafy": "./lib/terafy.client.ts",
+    "#utils/*": "./utils/*.ts"
   },
   "exports": {
     ".": {
-      "browser": "./lib/terafy.client.js",
-      "import": "./lib/terafy.client.js",
+      "types": "./dist/lib/terafy.client.d.ts",
+      "browser": "./dist/lib/terafy.client.js",
+      "import": "./dist/lib/terafy.client.js",
       "require": "./dist/terafy.js",
       "default": "./dist/terafy.js"
     },
-    "./bootstrap": "./lib/terafy.bootstrap.js",
-    "./dist/*": "./dist/*",
-    "./projectFile": "./lib/projectFile.js",
-    "./proxy": "./lib/terafy.proxy.js",
-    "./server": "./lib/terafy.server.js",
-    "./syncro": "./lib/syncro/syncro.js",
-    "./syncro/*": "./lib/syncro/*.js",
-    "./plugins/*": "./plugins/*.js",
+    "./bootstrap": {
+      "types": "./dist/lib/terafy.bootstrapper.d.ts",
+      "import": "./dist/lib/terafy.bootstrapper.js",
+      "default": "./dist/lib/terafy.bootstrapper.js"
+    },
+    "./projectFile": {
+      "types": "./dist/lib/projectFile.d.ts",
+      "import": "./dist/lib/projectFile.js",
+      "default": "./dist/lib/projectFile.js"
+    },
+    "./proxy": {
+      "types": "./dist/lib/terafy.proxy.d.ts",
+      "import": "./dist/lib/terafy.proxy.js",
+      "default": "./dist/lib/terafy.proxy.js"
+    },
+    "./server": {
+      "types": "./dist/lib/terafy.server.d.ts",
+      "import": "./dist/lib/terafy.server.js",
+      "default": "./dist/lib/terafy.server.js"
+    },
+    "./syncro": {
+      "types": "./dist/lib/syncro/syncro.d.ts",
+      "import": "./dist/lib/syncro/syncro.js",
+      "default": "./dist/lib/syncro/syncro.js"
+    },
+    "./syncro/*": {
+      "types": "./dist/lib/syncro/*.d.ts",
+      "import": "./dist/lib/syncro/*.js",
+      "default": "./dist/lib/syncro/*.js"
+    },
+    "./plugins/*": {
+      "types": "./dist/plugins/*.d.ts",
+      "import": "./dist/plugins/*.js",
+      "default": "./dist/plugins/*.js"
+    },
     "./widgets/*": "./widgets/*"
   },
+  "types": "./dist/lib/terafy.client.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/IEBH/TERA-fy.git"
@@ -54,7 +84,7 @@
       "url": "https://github.com/connorf25"
     },
     {
-      "name": "Justin Cark",
+      "name": "Justin Clark",
       "email": "jclark@bond.edu.au",
       "url": "https://github.com/Justin-Clarc"
     },
@@ -74,6 +104,7 @@
     "node": ">=18"
   },
   "dependencies": {
+    "@iebh/supabasey": "^1.1.0",
     "@momsfriendlydevco/marshal": "^2.1.4",
     "detect-port": "^2.1.0",
     "filesize": "^10.1.6",
@@ -86,13 +117,21 @@
     "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@momsfriendlydevco/eslint-config": "^2.1.3",
+    "@momsfriendlydevco/eslint-config": "^2.1.2",
     "@release-it/conventional-changelog": "^10.0.0",
+    "@types/detect-port": "^1.3.5",
+    "@types/http-proxy": "^1.17.14",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^18.0.0",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
     "concurrently": "^9.1.2",
     "documentation": "^14.0.3",
     "esbuild": "^0.25.0",
     "eslint": "^9.21.0",
-    "nodemon": "^3.1.9"
+    "nodemon": "^3.1.9",
+    "typescript": "^5.5.4"
   },
   "peerDependencies": {
     "@iebh/reflib": "^2.5.4",

package/plugins/{base.js → base.ts}

@@ -1,3 +1,5 @@
+import type TeraFy from "../lib/terafy.client.ts";
+
 /**
 * Base TeraFy plugin interface
 * This is included as a documentation exanple only
@@ -18,6 +20,6 @@ export default class TeraFyPlugin {
 	* @param {TeraFy} terafy The TeraFy client this plugin is being initalized against
 	* @param {Object} [options] Additional options to mutate behaviour
 	*/
-	constructor(terafy, options) { // eslint-disable-line no-unused-vars
+	constructor(terafy: TeraFy, options: Object) { // eslint-disable-line no-unused-vars
 	}
 }

package/plugins/{firebase.js → firebase.ts}

@@ -1,9 +1,10 @@
-import {initializeApp as Firebase} from 'firebase/app';
-import {getFirestore as Firestore} from 'firebase/firestore';
-import {createClient as Supabase} from '@supabase/supabase-js'
+import {initializeApp as Firebase, FirebaseApp} from 'firebase/app';
+import {getFirestore as Firestore, Firestore as FirestoreInstance} from 'firebase/firestore';
+import Supabasey from '@iebh/supabasey';
 import Syncro from '../lib/syncro/syncro.js';
 import TeraFyPluginBase from './base.js';
 
+
 /**
 * Plugin which adds Firebase / Firestore support for namespace mounts
 *
@@ -16,7 +17,13 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 	*
 	* @type {Object<Syncro>}
 	*/
-	syncros = {};
+	syncros: Record<string, Syncro> = {};
+	namespaces: Record<string, any> = {}; // Declare namespaces property
+
+	// Declare properties expected by the class methods or potentially inherited
+	getCredentials!: () => Promise<Record<string, any>>;
+	requireProject!: () => Promise<{ id: string }>;
+	debug!: (...args: any[]) => void;
 
 
 	/**
@@ -28,6 +35,7 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 	* @name getReactive
 	* @type {Function} A reactive function as defined in Syncro
 	*/
+	getReactive?: Function;
 
 
 	/**
@@ -44,7 +52,7 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 	*
 	* @returns {Promise} A Promise which will resolve when the init process has completed
 	*/
-	async init(options) {
+	async init(options?: any): Promise<void> { // Add optional '?' and type 'any', keep async Promise<void>
 		let settings = {
 			firebaseApiKey: null,
 			firebaseAuthDomain: null,
@@ -61,14 +69,19 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 			throw new Error('Firebase plugin requires mandatory options: ' + emptyValues.join(', '));
 
 		Syncro.firebase = Firebase({
-			apiKey: settings.firebaseApiKey,
-			authDomain: settings.firebaseAuthDomain,
-			projectId: settings.firebaseProjectId,
-			appId: settings.firebaseAppId,
+			apiKey: settings.firebaseApiKey!, // Add non-null assertion
+			authDomain: settings.firebaseAuthDomain!, // Add non-null assertion
+			projectId: settings.firebaseProjectId!, // Add non-null assertion
+			appId: settings.firebaseAppId!, // Add non-null assertion
 		});
-		Syncro.firestore = Firestore(this.firebase);
+		Syncro.firestore = Firestore(Syncro.firebase); // Use Syncro.firebase
 
-		Syncro.supabase = Supabase(settings.supabaseUrl, settings.supabaseKey);
+		Syncro.supabasey = await Supabasey.init({
+			env: {
+				SUPABASE_URL: settings.supabaseUrl!,
+				SUPABASE_KEY: settings.supabaseKey!, // Add non-null assertions
+			},
+		});
 	}
 
 
@@ -79,8 +92,8 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 	*
 	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
-	_mountNamespace(name) {
-		let syncro; // The eventually bootstrapped Syncro object
+	_mountNamespace(name: string): Promise<void> { // Add type 'string'
+		let syncro: Syncro; // Add type Syncro
 
 		return Promise.resolve()
 			.then(()=> this.requireProject())
@@ -90,7 +103,7 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 					: `project_namespaces::${project.id}::${name}`;
 
 				syncro = this.syncros[name] = new Syncro(path, {
-					debug: (...msg) => this.debug(`SYNCRO://${path}`, ...msg),
+					debug: (...msg: any[]) => this.debug(`SYNCRO://${path}`, ...msg), // Add type any[]
 					getReactive: this.getReactive, // Try to inherit this instances getReactive prop, otherwise Syncro will fall back to its default
 				});
 
@@ -110,13 +123,18 @@ export default class TeraFyPluginFirebase extends TeraFyPluginBase {
 	*
 	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
-	_unmountNamespace(name) {
+	_unmountNamespace(name: string): Promise<void | any[]> { // Add type 'string'
 		let syncro = this.syncros[name]; // Create local alias for Syncro before we detach it
 
 		// Detach local state
 		delete this.namespaces[name];
 		delete this.syncros[name];
 
-		return syncro.destroy(); // Trigger Syncro distruction
+		// Check if syncro exists before calling destroy
+		if (syncro) {
+			return syncro.destroy(); // Trigger Syncro distruction
+		} else {
+			return Promise.resolve(); // Or handle the case where syncro doesn't exist
+		}
 	}
 }

package/plugins/{vite.js → vite.ts}

@@ -8,12 +8,12 @@ import TeraProxy from '../lib/terafy.proxy.js';
 * @param {Object} [options] Options to pass to the Proxy module
 * @returns {VitePlugin}
 */
-export default function vitePluginTeraFy(options) {
+export default function vitePluginTeraFy(options: any) {
 
 	// Vite plugin config
 	return {
 		name: 'tera-fy',
-		apply(config, {command}) { // Only run within serve-mode rather than each build
+		apply(config: any, { command }: any) { // Only run within serve-mode rather than each build
 
 			// Don't run when building
 			if (command == 'build') return false;
@@ -21,4 +21,4 @@ export default function vitePluginTeraFy(options) {
 			TeraProxy(options);
 		},
 	}
-}
+}

package/plugins/{vue2.js → vue2.ts}

@@ -31,15 +31,21 @@ export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
 	*
 	* @type {Vue}
 	*/
-	Vue;
+	Vue: any;
+
+	/**
+	* The root Vue app instance
+	* @type {any}
+	*/
+	app: any;
 
 
 	/**
 	* The bound, reactive state of the active TERA project
 	*
-	* @type {Object}
+	* @type {Object | null}
 	*/
-	project = null;
+	project: any = null;
 
 
 	/**
@@ -61,7 +67,7 @@ export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
 	*
 	* @returns {Promise} A Promise which will resolve when the init process has completed
 	*/
-	async init(options) {
+	async init(options: any) {
 		let settings = {
 			app: null,
 			Vue: null,
@@ -80,13 +86,14 @@ export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
 			this.Vue.prototype[settings.globalName] = this;
 
 		await super.init(settings); // Initalize parent class Firebase functionality
-
+		// @ts-ignore
 		this.project = await this.mountNamespace('_PROJECT');
 	}
 
 
 	/** @override */
-	getReactive(value) {
+	// @ts-ignore
+	getReactive(value: any) {
 		let doc = this.Vue.observable(value);
 
 		let watcherPath = `_teraFy_${this.reactiveId++}`;
@@ -94,19 +101,19 @@ export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
 
 		return {
 			doc,
-			setState(state) {
+			setState: (state: any) => {
 				// Shallow copy all sub-keys into existing object (keeping the object pointer)
 				Object.entries(state || {})
 					.filter(([k]) => !isEqual(doc[k], state[k])) // Only accept changed keys
 					.forEach(([k, v]) => doc[k] = v)
 			},
-			getState() {
+			getState: () => {
 				return cloneDeep(doc);
 			},
-			watch: cb => {
+			watch: (cb: Function) => {
 				this.app.$watch(watcherPath, cb, {deep: true});
 			},
 		};
 	}
 
-}
+}

package/plugins/{vue3.js → vue3.ts}

@@ -1,6 +1,6 @@
 import {cloneDeep} from 'lodash-es';
 import TeraFyPluginFirebase from './firebase.js';
-import {reactive as vueReactive, watch as vueWatch} from 'vue';
+import {reactive as vueReactive, watch as vueWatch, App, WatchCallback} from 'vue';
 
 /**
 * Vue observables plugin
@@ -33,29 +33,31 @@ export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
 	*
 	* @type {Object}
 	*/
-	project = null;
+	project: any = null;
 
 
 	/**
 	* Init the project including create a reactive mount for the active project
 	*
 	* @param {Object} options Additional options to mutate behaviour
-	* @param {*...} [options...] see TeraFyPluginFirebase
+	* @param {*} [options...] see TeraFyPluginFirebase
 	*/
-	async init(options) {
+	async init(options: Record<string, any>) {
 		await super.init(options); // Initalize parent class Firebase functionality
 
 		// Mount the project namespace
+		// @ts-ignore
 		this.project = await this.mountNamespace('_PROJECT');
 	}
 
 
 	/** @override */
-	getReactive(value) {
+	// @ts-ignore
+	getReactive(value: any) {
 		let doc = vueReactive(value);
 		return {
 			doc,
-			setState(state) {
+			setState(state: any) {
 				// Shallow copy all sub-keys into existing object (keeping the object pointer)
 				Object.entries(state || {})
 					.forEach(([k, v]) => doc[k] = v)
@@ -63,7 +65,7 @@ export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
 			getState() {
 				return cloneDeep(doc);
 			},
-			watch(cb) {
+			watch(cb: WatchCallback<any, any>) {
 				vueWatch(doc, cb, {deep: true});
 			},
 		};
@@ -88,7 +90,7 @@ export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
 			* @param {Object} [options] Additional options to mutate behaviour
 			* @param {String} [options.globalName='$tera'] Global property to allocate this service as
 			*/
-			install(app, options) {
+			install(app: App, options: Record<string, any>) {
 				let settings = {
 					globalName: '$tera',
 					...options,
@@ -101,4 +103,4 @@ export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
 		};
 	}
 
-}
+}

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "sourceMap": true,
+    "paths": {
+      "#terafy": ["./lib/terafy.client.ts"],
+      "#utils/*": ["./utils/*.ts"]
+    }
+  },
+  "include": [
+    "lib/**/*.ts",
+    "plugins/**/*.ts",
+    "utils/**/*.ts",
+    "widgets/**/*.ts"
+   ],
+  "exclude": [
+    "node_modules",
+    "dist",
+  ]
+}

package/utils/{mixin.js → mixin.ts}

@@ -8,7 +8,7 @@
 * @param {Object} assignments Additional object properties to mix
 * @returns {Object} A shallow copy of the input instance extended with the assignments
 */
-export default function mixin(instance, assignments) {
+export default function mixin(instance: any, assignments: any) {
 	let output = Object.assign(
 		Object.create(Object.getPrototypeOf(instance)),
 		instance,

package/utils/{pDefer.js → pDefer.ts}

@@ -3,8 +3,15 @@
 * The defer object has the keys {promise, resolve(), reject()}
 * @returns {Defer} A defered promise
 */
-export default function() {
-	var deferred = {};
+
+interface Defer {
+  promise: Promise<unknown>;
+  resolve: (value?: unknown | PromiseLike<unknown>) => void;
+  reject: (reason?: any) => void;
+}
+
+export default function(): Defer {
+	var deferred = {} as Defer;
 
 	deferred.promise = new Promise((resolve, reject) => {
 		deferred.resolve = resolve;
@@ -12,4 +19,4 @@ export default function() {
 	});
 
 	return deferred;
-}
+}

package/utils/{pathTools.js → pathTools.ts}

@@ -33,7 +33,7 @@ import {
 *
 * @returns {*} The set value
 */
-export function set(target, path, value, options) {
+export function set(target: any, path: string | (string | number)[], value: any, options?: any): any {
 	let settings = {
 		strategy: 'overwrite',
 		...options,
@@ -76,7 +76,7 @@ export function set(target, path, value, options) {
 * @param {*} [fallback] Optional fallback to return if the end point does not exist
 * @returns {*} The fetched value
 */
-export function get(target, path, fallback) {
+export function get(target: any, path: string | (string | number)[], fallback?: any): any {
 	return _get(target, path, fallback);
 }
 
@@ -90,7 +90,7 @@ export function get(target, path, fallback) {
 * @param {String|Array} path The path within the target, to fetch in dotted or array notation
 * @returns {Boolean} True if the given path already exists within the subject
 */
-export function has(target, path) {
+export function has(target: any, path: string | (string | number)[]): boolean {
 	return _has(target, path);
 }
 
@@ -104,7 +104,7 @@ export function has(target, path) {
 *
 * @returns {*} The merged value
 */
-export function merge(target, path, value) {
+export function merge(target: any, path: string | (string | number)[], value: any): any {
 	_merge(get(target, path), value);
 	return value;
 }
@@ -119,11 +119,13 @@ export function merge(target, path, value) {
 *
 * @returns {*} The resulting object with defaults applied
 */
-export function defaults(target, path, value) {
+export function defaults(target: any, path: string | (string | number)[] | any, value?: any): any {
 	if (typeof path == 'string' || Array.isArray(path)) { // Called as (target, path, value)
-		return !has(target, path)  // Target path doesn't exist at all
-			? set(target, path, value)
-			: _defaults(get(target, path), value);
+		if (!has(target, path)) { // Target path doesn't exist at all
+			return set(target, path, value);
+		} else { // Target path exists - apply Lodash defaults
+			return _defaults(get(target, path), value);
+		}
 	} else { // Called as (target, value)
 		return _defaults(target, path);
 	}
@@ -137,4 +139,4 @@ export default {
 	has,
 	merge,
 	defaults,
-};
+};