@lightningjs/renderer 0.3.0 → 0.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/renderer",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Lightning 3 Renderer",
   "type": "module",
   "main": "./dist/exports/index.js",
@@ -27,7 +27,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lightningDriePuntNul/renderer.git"
+    "url": "git+https://github.com/lightning-js/renderer.git"
   },
   "keywords": [
     "Lightning",
@@ -39,9 +39,9 @@
   "author": "Comcast Cable Communications Management, LLC",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/ightningDriePuntNul/renderer/issues"
+    "url": "https://github.com/lightning-js/renderer/issues"
   },
-  "homepage": "https://github.com/ightningDriePuntNul/renderer#readme",
+  "homepage": "https://github.com/lightning-js/renderer#readme",
   "devDependencies": {
     "@types/node": "^18.14.6",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
@@ -57,7 +57,7 @@
     "vitest": "^0.34.2"
   },
   "dependencies": {
-    "@lightningjs/threadx": "^0.3.0",
+    "@lightningjs/threadx": "^0.3.1",
     "@protobufjs/eventemitter": "^1.1.0"
   },
   "lint-staged": {
@@ -69,6 +69,7 @@
   },
   "files": [
     "dist",
+    "src",
     "LICENSE",
     "NOTICE",
     "README.md"

package/src/common/CommonTypes.ts

@@ -0,0 +1,70 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Types shared between Main Space and Core Space
+ *
+ * @remarks
+ *
+ * @module
+ */
+
+/**
+ * Represents a width and height.
+ */
+export interface Dimensions {
+  width: number;
+  height: number;
+}
+
+/**
+ * Event handler for when a texture is loading
+ */
+export type TextureLoadingEventHandler = (target: any) => void;
+
+/**
+ * Event handler for when a texture is loaded
+ */
+export type TextureLoadedEventHandler = (
+  target: any,
+  dimensions: Readonly<Dimensions>,
+) => void;
+
+/**
+ * Event handler for when a texture fails to load
+ */
+export type TextureFailedEventHandler = (target: any, error: Error) => void;
+
+/**
+ * Event handler for when text is loading
+ */
+export type TextLoadingEventHandler = (target: any) => void;
+
+/**
+ * Event handler for when text is loaded
+ */
+export type TextLoadedEventHandler = (
+  target: any,
+  dimensions: Dimensions,
+) => void;
+
+/**
+ * Event handler for when text fails to load
+ */
+export type TextFailedEventHandler = (target: any, error: Error) => void;

package/src/common/EventEmitter.ts

@@ -0,0 +1,77 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { IEventEmitter } from '@lightningjs/threadx';
+
+/**
+ * EventEmitter base class
+ */
+export class EventEmitter implements IEventEmitter {
+  private eventListeners: { [eventName: string]: any } = {};
+
+  on(event: string, listener: (target: any, data: any) => void): void {
+    let listeners = this.eventListeners[event];
+    if (!listeners) {
+      listeners = [];
+    }
+    listeners.push(listener);
+    this.eventListeners[event] = listeners;
+  }
+
+  off(event: string, listener?: (target: any, data: any) => void): void {
+    const listeners = this.eventListeners[event];
+    if (!listeners) {
+      return;
+    }
+    if (!listener) {
+      delete this.eventListeners[event];
+      return;
+    }
+    const index = listeners.indexOf(listener);
+    if (index >= 0) {
+      listeners.splice(index, 1);
+    }
+  }
+
+  once(event: string, listener: (target: any, data: any) => void): void {
+    const onceListener = (target: any, data: any) => {
+      this.off(event, onceListener);
+      listener(target, data);
+    };
+    this.on(event, onceListener);
+  }
+
+  emit(event: string, data?: any): void {
+    const listeners = this.eventListeners[event];
+    if (!listeners) {
+      return;
+    }
+    [...listeners].forEach((listener) => {
+      listener(this, data);
+    });
+  }
+
+  removeAllListeners() {
+    this.eventListeners = {};
+  }
+}

package/src/common/IAnimationController.ts

@@ -0,0 +1,29 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export type AnimationControllerState = 'running' | 'paused' | 'stopped';
+
+export interface IAnimationController {
+  start(): IAnimationController;
+  stop(): IAnimationController;
+  pause(): IAnimationController;
+  restore(): IAnimationController;
+  waitUntilStopped(): Promise<void>;
+  readonly state: AnimationControllerState;
+}

package/src/core/CoreExtension.ts

@@ -0,0 +1,32 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Stage } from './Stage.js';
+
+/**
+ * Base class for Core extensions.
+ *
+ * @remarks
+ * Core extensions are used to extend the Core Renderer with custom code such as
+ * custom fonts, custom shaders, custom textures, custom animation functions,
+ * and more.
+ */
+export abstract class CoreExtension {
+  abstract run(stage: Stage): Promise<void>;
+}