refactor: app structure reorder + assets optimisation

nuxt.config.ts

@@ -4,11 +4,15 @@ import glslify from "vite-plugin-glslify";
 export default defineNuxtConfig({
 	devtools: { enabled: true },
 	alias: {
-		"@exp-factories/*": "../src/experiences/factories/*",
-		"@exp-errors/*": "../src/experiences/errors/*",
-		"@exp-pages/*": "../src/experiences/pages/*",
-		"@interfaces/*": "../src/interfaces/*",
-		"@constants/*": "../src/constants/*",
+		"~blueprints/*": "../src/blueprints/*",
+		"~config": "../src/config",
+		"~config/*": "../src/config/*",
+		"~experiences/*": "../src/experiences/*",
+		"~errors": "../src/errors",
+		"~errors/*": "../src/errors/*",
+		"~common/*": "../src/common/*",
+		"~static": "../src/static",
+		"~static/*": "../src/static/*",
 	},
 	app: {
 		head: {

src/experiences/blueprints/experience-based.blueprint.ts → src/blueprints/experiences/experience-based.blueprint.ts

@@ -3,13 +3,13 @@ import { EventEmitter } from "events";
 // BLUEPRINTS
 import type { ExperienceBlueprint } from "./experience.blueprint";
 
-// INTERFACES
-import type { ExperienceBase } from "~/interfaces/experienceBase";
+// MODELS
+import type { Experience } from "~/common/experiences/experience.model";
 
 /** Represent a class that depend on {@link ExperienceBlueprint}. */
 export abstract class ExperienceBasedBlueprint
 	extends EventEmitter
-	implements ExperienceBase
+	implements Experience
 {
 	protected abstract readonly _experience: ExperienceBlueprint;
 

src/experiences/blueprints/Experience.blueprint.ts → src/blueprints/experiences/experience.blueprint.ts

@@ -1,20 +1,12 @@
 import QuickThree from "quick-threejs";
 
-// INTERFACES
-import type { ExperienceBase } from "@/interfaces/experienceBase";
+// MODELS
+import type {
+	Experience,
+	ExperienceConstructorProps,
+} from "~/common/experiences/experience.model";
 
-export interface ExperienceProps {
-	/** String dom element reference of the canvas. */
-	domElementRef?: string;
-	/* Start the project in debug mode */
-	debug?: boolean;
-	/** Event triggered when the scene is constructed. */
-	onConstruct?: () => unknown;
-	/** Event triggered when the scene is destructed. */
-	onDestruct?: () => unknown;
-}
-
-export abstract class ExperienceBlueprint implements ExperienceBase {
+export abstract class ExperienceBlueprint implements Experience {
 	/**
 	 * Self class reference. Used for *singleton* pattern.
 	 *
@@ -26,7 +18,7 @@ export abstract class ExperienceBlueprint implements ExperienceBase {
 	/** [`quick-threejs`](https://www.npmjs.com/package/quick-threejs) instance. */
 	readonly app!: QuickThree;
 	/** To make the singleton logic, refer to the {@link ExperienceBlueprint._self `#_self`} declaration */
-	constructor(_?: ExperienceProps | ExperienceBlueprint) {
+	constructor(_?: ExperienceConstructorProps | ExperienceBlueprint) {
 		if (!(_ instanceof ExperienceBlueprint) && _) {
 			this.app = new QuickThree(
 				{

src/experiences/blueprints/scene-component.blueprint.ts → src/blueprints/experiences/scene-component.blueprint.ts

@@ -5,20 +5,19 @@ import type { GLTF } from "three/examples/jsm/loaders/GLTFLoader";
 import { ExperienceBasedBlueprint } from "./experience-based.blueprint";
 
 // EXPERIENCES
-import { HomeExperience } from "~/experiences/core/home";
+import { HomeExperience } from "~/experiences/home";
 
-// MODELS
-import { CONSTRUCTED, DESTRUCTED, LOADED } from "~/common/event.model";
-import { WRONG_PARAM } from "~/common/error.model";
+// STATIC
+import { errors, events } from "~/static";
 
 // ERRORS
-import { ErrorFactory } from "../errors/error.factory";
+import { ErrorFactory } from "~/errors";
 
-// INTERFACES
+// MODELS
 import type {
 	Materials,
 	ModelChildrenMaterials,
-} from "~/interfaces/experienceWorld";
+} from "~/common/experiences/experience-world.model";
 
 // TODO: Link with the names of assets in the `app.loader` assets names
 export interface SceneBlueprintProps {
@@ -50,7 +49,7 @@ export abstract class SceneComponentBlueprint extends ExperienceBasedBlueprint {
 
 		this._childrenMaterials = _.childrenMaterials;
 
-		this._experience.loader?.on(LOADED, () => {
+		this._experience.loader?.on(events.LOADED, () => {
 			const _MODEL = this._experience.app.resources.items[_.modelName] as
 				| GLTF
 				| undefined;
@@ -108,7 +107,7 @@ export abstract class SceneComponentBlueprint extends ExperienceBasedBlueprint {
 
 		if (!this.modelScene)
 			throw new ErrorFactory(
-				new Error("No model scene founded", { cause: WRONG_PARAM })
+				new Error("No model scene founded", { cause: errors.WRONG_PARAM })
 			);
 
 		if (typeof callback === "function") callback();
@@ -118,13 +117,13 @@ export abstract class SceneComponentBlueprint extends ExperienceBasedBlueprint {
 			...this._getAvailableMaterials(),
 		};
 		this._initModelMaterials();
-		this.emit(CONSTRUCTED);
+		this.emit(events.CONSTRUCTED);
 	}
 
 	public destruct() {
 		this.modelScene?.clear();
 		this.modelScene?.removeFromParent();
-		this.emit(DESTRUCTED);
+		this.emit(events.DESTRUCTED);
 	}
 
 	public intro(): void {}

src/interfaces/experienceWorld.ts → src/common/experiences/experience-world.model.ts

@@ -1,4 +1,4 @@
-import { CatmullRomCurve3, Material, Vector3 } from "three";
+import { Material } from "three";
 
 export type MaterialName = string;
 
@@ -9,9 +9,3 @@ export interface Materials {
 export interface ModelChildrenMaterials {
 	[childName: string]: MaterialName;
 }
-
-export interface SceneConfig {
-	position: Vector3;
-	center: Vector3;
-	cameraPath: CatmullRomCurve3;
-}

src/common/experiences/experience.model.ts

@@ -0,0 +1,17 @@
+/** Represent the base structure of all experience classes in the application. */
+export interface Experience {
+	construct: (callback?: () => unknown) => unknown;
+	destruct: (callback?: () => unknown) => unknown;
+	update?: (callback?: () => unknown) => unknown;
+}
+
+export interface ExperienceConstructorProps {
+	/** String dom element reference of the canvas. */
+	domElementRef?: string;
+	/* Start the project in debug mode */
+	debug?: boolean;
+	/** Event triggered when the scene is constructed. */
+	onConstruct?: () => unknown;
+	/** Event triggered when the scene is destructed. */
+	onDestruct?: () => unknown;
+}

src/experiences/config/index.ts → src/config/index.ts

@@ -1,7 +1,7 @@
 import { CommonConfig } from "./common.config";
 
 export class Config extends CommonConfig {
-	protected static _supportsPassive = false;
+	private static _supportsPassive = false;
 
 	static set supportsPassive(val: boolean) {
 		Config._supportsPassive = !!val;

src/experiences/errors/Error.factory.ts → src/errors/index.ts

@@ -1,4 +1,4 @@
-import { UnknownError } from "./unknown-error";
+import { UnknownError } from "./unknown.error";
 
 export class ErrorFactory {
 	constructor(_: any) {