@iebh/tera-fy 2.3.10 → 2.3.12

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

@@ -1,17 +1,6 @@
-/* eslint-disable no-unused-vars */
-import { filesize } from 'filesize';
-import { pick, omit } from 'lodash-es';
-import type TeraFy from './terafy.client.js';
-
-// TODO: Refactor terafy.client.ts so that we don't need to extend the class with injected functions
-interface TeraClient extends TeraFy {
-	getProjectFileContents: (id: any, options?: any) => any
-	setProjectFileContents: (id: any, contents: any, options?: any) => any
-	getProjectLibrary: (id: any, options?: any) => any
-	setProjectLibrary: (id: any, refs:any, options?: any) => any
-};
-type SupabaseFile = any;
-type RefLibRef = any;
+import {filesize} from 'filesize';
+import {pick, omit} from 'lodash-es';
+
 
 /**
 * A project file fetched from TERA
@@ -21,10 +10,10 @@ export default class ProjectFile {
 
 	/**
 	* Parent TeraClient instance used by all helper functions
-	* @type {TeraClient}
+	* @type {Object}
 	* @private
 	*/
-	_tera!: TeraClient;
+	_tera;
 
 
 	/**
@@ -32,28 +21,28 @@ export default class ProjectFile {
 	* NOTE: This is computed each time from the Base64 of the file path
 	* @type {String}
 	*/
-	id!: string;
+	id;
 
 
 	/**
 	* The raw Supabase UUID of the file
 	* @type {String}
 	*/
-	sbId!: string;
+	sbId;
 
 
 	/**
 	* Relative name path (can contain prefix directories) for the human readable file name
 	* @type {String}
 	*/
-	name!: string;
+	name;
 
 
 	/**
 	* CSS class to use as the file icon
 	* @type {String}
 	*/
-	icon!: string;
+	icon;
 
 
 	/**
@@ -61,7 +50,7 @@ export default class ProjectFile {
 	* This is also used as the unique identifier within the project
 	* @type {String}
 	*/
-	path!: string;
+	path;
 
 
 	/**
@@ -69,7 +58,7 @@ export default class ProjectFile {
 	* This will usually open an edit UI within the TERA site
 	* @type {String}
 	*/
-	url!: string;
+	url;
 
 
 	/**
@@ -77,7 +66,7 @@ export default class ProjectFile {
 	* This is used to direct to the edit/view/download UI when the files project is active and is usually used in place of URL for TERA related operations
 	* @type {String}
 	*/
-	teraUrl!: string;
+	teraUrl;
 
 
 	/**
@@ -88,103 +77,101 @@ export default class ProjectFile {
 	* @property {String} ext The extension portion of the name (always lower case)
 	* @property {String} dirName The directory path portion of the name
 	*/
-	// Using 'any' for simplicity, define an interface for better type safety if desired
-	parsedName: any;
+	parsedName;
 
 
 	/**
 	* A date representing when the file was created
 	* @type {Date}
 	*/
-	// Using Date | undefined because constructor checks if it exists
-	created: Date | undefined;
+	created;
 
 
 	/**
 	* A human readable, formatted version of "created"
 	* @type {String}
 	*/
-	createdFormatted!: string;
+	createdFormatted;
 
 
 	/**
-	* A date representing when the file was created
+	* A date representing when the file was modifed
 	* @type {Date}
 	*/
-	// Using Date | undefined because constructor checks if it exists
-	modified: Date | undefined;
+	modified;
 
 
 	/**
 	* A human readable, formatted version of "modified"
 	* @type {String}
 	*/
-	modifiedFormatted!: string;
+	modifiedFormatted;
 
 
 	/**
 	* A date representing when the file was last accessed
 	* @type {Date}
 	*/
-	// Using Date | undefined because constructor checks if it exists
-	accessed: Date | undefined;
+	accessed;
 
 
 	/**
 	* A human readable, formatted version of "accessed"
 	* @type {String}
 	*/
-	accessedFormatted!: string;
+	accessedFormatted;
 
 
 	/**
 	* Size, in bytes, of the file
 	* @type {Number}
 	*/
-	// Using number | undefined because constructor uses `|| 0`
-	size: number | undefined;
+	size;
 
 
 	/**
 	* A human readable, formatted version of the file size
 	* @type {String}
 	*/
-	sizeFormatted!: string;
+	sizeFormatted;
 
 
 	/**
 	* The associated mime type for the file
 	* @type {String}
 	*/
-	mime!: string;
+	mime;
 
 
 	/**
 	* Additional meta information for the file
 	* @type {Object}
 	*/
-	// Using Record<string, any> for a generic object, adjust if meta has a known structure
-	meta: Record<string, any> = {};
+	meta = {};
+
 
 	/**
-	 * Whether this is a folder or not
-	 */
-	isFolder!: boolean;
+	* Whether this is a folder or not
+	* @type {Boolean}
+	*/
+	isFolder;
+
 
 	/**
-	 * If it is a folder, it will have an array of files in the folder
-	 */
-	files?: ProjectFile[];
+	* If it is a folder, it will have an array of files in the folder
+	* @type {Array<ProjectFile>}
+	*/
+	files;
+
 
 	/**
 	* ProjectFile constructor
 	* Takes the input basic file type from Supabase and adds additional formatted fields
-	* @param {SupabaseFile} baseFile The basic Supabase file to extend
-	* @param {TeraFyClient} baseFile.tera The associated TeraFyClient instance to use for some file methods
+	* @param {Object} baseFile The basic Supabase file to extend
+	* @param {Object} baseFile.tera The associated TeraFyClient instance to use for some file methods
 	*/
-
-	constructor(baseFile: SupabaseFile) {
-		// Note: baseFile.tera is assumed to exist based on the check below and the SupabaseFile type definition above
+	constructor(baseFile) {
+		// Note: baseFile.tera is assumed to exist based on the check below
 		if (!baseFile.tera) throw new Error('Basic file requires a `tera` key to access the Tera instance');
 		Object.assign(this, omit(baseFile, 'encodeIdFunction')); // don't copy encodeIdFunction
 
@@ -194,7 +181,7 @@ export default class ProjectFile {
 		}
 
 		// Translate baseFile.tera -> this._tera (non-enumerable, non-configurable)
-		const tera = (this as any).tera;
+		const tera = this.tera;
 		Object.defineProperty(this, '_tera', {
 			enumerable: false,
 			configurable: false,
@@ -203,8 +190,7 @@ export default class ProjectFile {
 				return tera;
 			},
 		});
-
-		delete (this as any).tera; // Remove original ref we merged above
+		delete this.tera; // Remove original ref we merged above
 
 		// Ensure date properties are actual Date objects, not strings.
 		// This makes the class resilient to the format of the input data.
@@ -228,7 +214,7 @@ export default class ProjectFile {
 					url = url.replace(/\/project\/download\//, '/project/library/');
 				}
 				return new ProjectFile({
-					tera: this._tera,
+					tera,
 					...file,
 					sbId: file.id, // Sash the original Supabase ID under sbId
 					id: file.path,
@@ -244,7 +230,7 @@ export default class ProjectFile {
 		this.teraUrl = this.url.replace(/^https?:\/\/(?:.+?)\/projects\/(?:.+?)\/project\/(.+)$/, '/project/$1');
 
 		// Set all `*Formatted` fields
-		this.sizeFormatted = filesize(this.size || 0, { spacer: '' });
+		this.sizeFormatted = filesize(this.size || 0, {spacer: ''});
 		this.createdFormatted = this.created ? this.created.toLocaleDateString() : 'Unknown created date';
 		this.modifiedFormatted = this.modified ? this.modified.toLocaleDateString() : 'Unknown modified date';
 		this.accessedFormatted = this.accessed ? this.accessed.toLocaleDateString() : 'Unknown access date';
@@ -260,9 +246,7 @@ export default class ProjectFile {
 	*
 	* @see getProjectFile()
 	*/
-
-	getContents(options?: any): Promise<Blob> {
-		// Assuming _tera has this method and it returns Promise<Blob>
+	getContents(options) {
 		return this._tera.getProjectFileContents(this.id, options);
 	}
 
@@ -276,9 +260,7 @@ export default class ProjectFile {
 	*
 	* @see setProjectFileContents()
 	*/
-
-	setContents(contents: File | Blob | FormData | object | any[]): Promise<void> {
-		// Assuming _tera has this method and it returns Promise<void> or similar
+	setContents(contents) {
 		return this._tera.setProjectFileContents(this.id, contents, {});
 	}
 
@@ -286,13 +268,11 @@ export default class ProjectFile {
 	/**
 	* Fetch the file contents as an array of Reflib refs
 	*
-	* @returns {Promise<Array<RefLibRef>>} An eventual array of RefLib references
+	* @returns {Promise<Array>} An eventual array of RefLib references
 	*
 	* @see getProjectLibrary()
 	*/
-
-	getRefs(): Promise<Array<RefLibRef>> {
-		// Assuming _tera has this method and it returns Promise<Array<RefLibRef>>
+	getRefs() {
 		return this._tera.getProjectLibrary(this.id);
 	}
 
@@ -300,15 +280,13 @@ export default class ProjectFile {
 	/**
 	* Overwrite the contents of a file with a new collection of Reflib refs
 	*
-	* @param {Array<RefLibRef>} refs Collection of references for the selected library
+	* @param {Array} refs Collection of references for the selected library
 	*
 	* @returns {Promise<void>} A promise which resolves when the operation has completed
 	*
 	* @see setProjectLibrary()
 	*/
-
-	setRefs(refs: Array<RefLibRef>): Promise<void> {
-		// Assuming _tera has this method and it returns Promise<void> or similar
+	setRefs(refs) {
 		return this._tera.setProjectLibrary(this.id, refs);
 	}
 
@@ -320,8 +298,7 @@ export default class ProjectFile {
 	* @see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 	* @returns {Object} A Structured Clone compatible representation of this ProjectFile instance
 	*/
-
-	serialize(): Partial<ProjectFile> { // Using Partial<ProjectFile> as it returns a subset
+	serialize() {
 		return pick(this, [
 			'id',
 			'sbId',
@@ -349,8 +326,7 @@ export default class ProjectFile {
 	* @param {Object} data An input object created via `ProjectFiles.serialize()` (MUST include a 'tera' property added manually)
 	* @returns {ProjectFile} A ProjectFile instance setup against the deserialized data
 	*/
-
-	static deserialize(data: any): ProjectFile {
+	static deserialize(data) {
 		// TODO: Check the below
 		// WARNING: The original 'serialize' method does NOT include 'tera'.
 		// The caller of 'deserialize' MUST add the correct 'tera' instance to the 'data' object
@@ -378,4 +354,4 @@ export default class ProjectFile {
 		]);
 		return new ProjectFile(constructorArg);
 	}
-}
+}

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

@@ -1,75 +1,6 @@
-/* eslint-disable jsdoc/reject-function-type, no-unused-vars */
-// @ts-expect-error TODO: Remove when reflib gets declaration file
 import Reflib from '@iebh/reflib';
 import {v4 as uuid4} from 'uuid';
 import {nanoid} from 'nanoid';
-import {BoundSupabaseyFunction} from '@iebh/supabasey';
-
-
-// Minimal interface for a postgres-npm Sql instance (HYPERDRIVE is injected by the Cloudflare Worker runtime)
-export interface PostgresSql {
-	(strings: TemplateStringsArray, ...values: any[]): Promise<any[]>;
-	json(value: any): any;
-}
-
-
-// DATABASE TABLE TYPE DEFINITIONS {{{
-interface ProjectRow {
-	data: {
-		id: string;
-		// TODO: add other properties in project data
-	};
-	// TODO: Define other columns in project table
-}
-
-interface InstituteRow {
-	data: any;
-}
-
-interface UserRow {
-	id: string;
-	data: {
-		id: string;
-		credits: number;
-		[key: string]: any;
-		// TODO: add other properties in user data
-	};
-	// TODO: Define other columns in user table
-}
-
-interface NamespaceRow {
-	project: string;
-	name: string;
-	data: {
-		[key: string]: any;
-		// TODO: add other properties in namespace data
-	};
-	// TODO: Define other columns in namespace table
-}
-// }}}
-
-
-// Interface for each syncro entity config
-interface SyncroEntityConfig {
-	singular: string;
-	initState: (args: {
-		HYPERDRIVE: PostgresSql;
-		supabasey: BoundSupabaseyFunction;
-		id: string; // Primary ID for the entity
-		relation?: string; // Optional relation identifier (for namespaces, libraries)
-	}) => Promise<any>;
-	flushState: (args: {
-		HYPERDRIVE: PostgresSql;
-		supabasey?: BoundSupabaseyFunction;
-		state: any; // The state object to flush
-		id?: string; // Primary ID (used in some lookups like namespaces)
-		fsId?: string; // ID often passed to Supabase RPCs (might be same as 'id')
-		relation?: string; // Optional relation identifier
-	}) => Promise<any>; // Return type signifies completion/result of flush
-}
-
-
-type SyncroConfig = Record<string, SyncroEntityConfig>;
 
 
 /**
@@ -78,13 +9,13 @@ type SyncroConfig = Record<string, SyncroEntityConfig>;
 * @type {Object} An object lookup of entities
 *
 * @property {String} singular The singular noun for the item
-* @property {Function} initState Function called to initialize state when Firestore has no existing document. Called as `({HYPERDRIVE:PostgresSql, supabasey:BoundSupabaseyFunction, id:String, relation?:string})` and expected to return the initial data object state
-* @property {Function} flushState Function called to flush state from Firebase to Postgres. Called the same as `initState` + `{state:Object}`
+* @property {Function} initState Function called to initialize state when Firestore has no existing document. Called as `({HYPERDRIVE, supabasey, id, relation?})` and expected to return the initial data object state
+* @property {Function} flushState Function called to flush state from Firebase to Postgres. Called the same as `initState` + `{state}`
 */
-const syncroConfig: SyncroConfig = {
+const syncroConfig = {
 	institutes: { // {{{
 		singular: 'institute',
-		async initState({HYPERDRIVE, id}: {HYPERDRIVE: PostgresSql, id: string}) {
+		async initState({HYPERDRIVE, id}) {
 			let rows = await HYPERDRIVE`
 				SELECT data
 				FROM institutes
@@ -109,7 +40,7 @@ const syncroConfig: SyncroConfig = {
 	}, // }}}
 	projects: { // {{{
 		singular: 'project',
-		async initState({HYPERDRIVE, supabasey, id}: {HYPERDRIVE: PostgresSql, supabasey: BoundSupabaseyFunction, id: string}) {
+		async initState({HYPERDRIVE, supabasey, id}) {
 			let rows = await HYPERDRIVE`
 				SELECT data
 				FROM projects
@@ -123,7 +54,7 @@ const syncroConfig: SyncroConfig = {
 			// MIGRATION - Move data.temp{} into Supabase files + add pointer to filename {{{
 			if (
 				data.temp // Project contains temp subkey
-				&& Object.values(data.temp).some((t: any) => typeof t == 'object') // Some of the temp keys are objects
+				&& Object.values(data.temp).some(t => typeof t == 'object') // Some of the temp keys are objects
 			) {
 				console.log('[MIGRATION] tera-fy project v1 -> v2', data.temp);
 				const tempObject = data.temp;
@@ -139,7 +70,7 @@ const syncroConfig: SyncroConfig = {
 							console.log('[MIGRATION] Creating filename:', fileName);
 
 							return Promise.resolve()
-								.then(()=> supabasey((supabase) => supabase // Split data.temp[toolKey] -> file {{{
+								.then(()=> supabasey(supabase => supabase // Split data.temp[toolKey] -> file {{{
 									.storage
 									.from('projects')
 									.upload(
@@ -190,20 +121,20 @@ const syncroConfig: SyncroConfig = {
 	}, // }}}
 	project_libraries: { // {{{
 		singular: 'project library',
-		async initState({id, relation, supabasey}: {HYPERDRIVE: PostgresSql, id: string, relation?: string, supabasey: BoundSupabaseyFunction}) {
+		async initState({id, relation, supabasey}) {
 			if (!relation || !/_\*$/.test(relation)) throw new Error('Project library relation missing, path should resemble "project_library::${PROJECT}::${LIBRARY_FILE_ID}_*"');
 
 			const fileId = relation.replace(/_\*$/, '');
 
-			const files = await supabasey((supabase) => supabase
+			const files = await supabasey(supabase => supabase
 				.storage
 				.from('projects')
 				.list(id))
 
-			const file = files?.find((f: any) => f.id == fileId);
+			const file = files?.find(f => f.id == fileId);
 			if (!file) return Promise.reject(`Invalid file ID "${fileId}"`);
 
-			const blob = await supabasey((supabase) => supabase
+			const blob = await supabasey(supabase => supabase
 				.storage
 				.from('projects')
 				.download(`${id}/${file.name}`))
@@ -218,7 +149,7 @@ const syncroConfig: SyncroConfig = {
 			})
 
 			return Object.fromEntries(refs // Transform Reflib Ref array into a keyed UUID object
-				.map((ref: any) => [ // Construct Object.fromEntries() compatible object [key, val] tuple
+				.map(ref => [ // Construct Object.fromEntries() compatible object [key, val] tuple
 					uuid4(), // TODO: This should really be using V5 with some-kind of namespacing but I can't get my head around the documentation - MC 2025-02-21
 					ref, // The actual ref payload
 				])
@@ -239,7 +170,7 @@ const syncroConfig: SyncroConfig = {
 	}, // }}}
 	test: { // {{{
 		singular: 'test',
-		async initState({HYPERDRIVE, id}: {HYPERDRIVE: PostgresSql, id: string}) {
+		async initState({HYPERDRIVE, id}) {
 			let rows = await HYPERDRIVE`
 				SELECT data
 				FROM test
@@ -264,7 +195,7 @@ const syncroConfig: SyncroConfig = {
 	}, // }}}
 	users: { // {{{
 		singular: 'user',
-		async initState({HYPERDRIVE, id}: {HYPERDRIVE: PostgresSql, id: string}) {
+		async initState({HYPERDRIVE, id}) {
 			let rows = await HYPERDRIVE`
 				SELECT data
 				FROM users