@splinetool/runtime 0.6.13 → 0.6.17

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@splinetool/runtime",
-  "version": "0.6.13",
+  "version": "0.6.17",
   "main": "build/runtime.js",
   "files": [
-    "build"
+    "build",
+    "runtime.d.ts"
   ],
+  "types": "./runtime.d.ts",
   "scripts": {
     "start": "cross-env NODE_ENV=development node --experimental-json-modules ./esbuild.mjs",
     "build": "cross-env NODE_ENV=production node --experimental-json-modules ./esbuild.mjs",
@@ -23,7 +25,7 @@
     "prettier": "^2.3.2",
     "raw-loader": "^4.0.2",
     "source-map-explorer": "^2.5.2",
-    "spe": "0.0.0",
+    "spe": "workspace:*",
     "three": "0.131.3",
     "typescript": "^4.1.3"
   },
@@ -42,4 +44,4 @@
   "dependencies": {
     "on-change": "^4.0.0"
   }
-}
+}

package/runtime.d.ts

@@ -0,0 +1,109 @@
+declare module '@splinetool/runtime' {
+	export type SplineEvent = {
+		target: {
+			name: string;
+			id: string;
+		};
+	};
+
+	export type SplineEventName =
+		| 'mouseDown'
+		| 'mouseUp'
+		| 'mouseHover'
+		| 'keyDown'
+		| 'keyUp'
+		| 'start'
+		| 'lookAt'
+		| 'follow';
+
+	export type SPEObject = {
+		name: string;
+		uuid: string;
+		visible: boolean;
+		intensity: number;
+		position: { x: number; y: number; z: number };
+		rotation: { x: number; y: number; z: number };
+		scale: { x: number; y: number; z: number };
+		/**
+		 * Triggers a Spline event.
+		 * Starts from firt state to last state.
+		 * @param {string} eventName String that matches Spline event's name
+		 * @param {string}	uuid String to match to the object's uuid
+		 */
+		emitEvent: (eventName: SplineEventName) => void;
+		/**
+		 * Triggers a Spline event in reverse order.
+		 * Starts from last state to first state.
+		 * @param {string} eventName String that matches Spline event's name
+		 */
+		emitEventReverse: (eventName: SplineEventName) => void;
+	};
+
+	export class Application {
+		autoRender: boolean;
+		canvas: HTMLCanvasElement;
+		constructor(
+			canvas: HTMLCanvasElement,
+			{ autoRender }: { autoRender: true }
+		);
+		load(path: string): Promise<void>;
+		start(json: any): Promise<void>;
+		/**
+		 *  Searches through scene's children and returns the object with that uuid
+		 * @param uuid	String to match to the object's uuid
+		 * @returns SPEObject
+		 */
+		findObjectById(uuid: string): SPEObject | undefined;
+		/**
+		 * Searches through scene's children and returns the first object with that name
+		 * @param  {string}	name
+		 * @returns {Object} SPEObject
+		 */
+		findObjectByName(name: string): SPEObject | undefined;
+		/**
+		 * Returns an array of Spline events
+		 * @returns {Array.<Object>}
+		 */
+		getSplineEvents(): {
+			[key: string]: {
+				[key: string]: CustomEvent<any>;
+			};
+		};
+		/**
+		 * Triggers a Spline event associated to an object with provided uuid.
+		 * Starts from first state to last state.
+		 * @param {string} eventName String that matches Spline event's name
+		 * @param {string} uuid
+		 */
+		emitEvent(eventName: SplineEventName, uuid: string): void;
+		/**
+		 * Triggers a Spline event associated to an object with provided uuid in reverse order.
+		 * Starts from last state to first state.
+		 * @param {string} eventName String that matches Spline event's name
+		 * @param {string}	uuid
+		 */
+		emitEventReverse(eventName: SplineEventName, uuid: string): void;
+		/**
+		 * Add an event listener for Spline events
+		 * @param {string} eventName String that matches Spline event's name
+		 * @param {function} cb	A callback function with Spline event as parameter
+		 */
+		addEventListener(
+			eventName: SplineEventName,
+			cb: (e: SplineEvent) => void
+		): void;
+		/**
+		 * Removes the event listener for a Spline event with the same name and callback
+		 * @param {string} eventName String that matches Spline event's name
+		 * @param {function} cb	A callback function with Spline event as parameter
+		 */
+		removeEventListener(
+			eventName: SplineEventName,
+			cb: (e: SplineEvent) => void
+		): void;
+		/**
+		 * Deactivates runtime
+		 */
+		unmount(): void;
+	}
+}