Merge pull request #558 from elsassph/fix/update-types

wouterlucas · web-flow · commit c188d6ba2049 · 2025-02-04T15:36:22.000+01:00
Update types
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -54,7 +54,7 @@
     "@babel/plugin-transform-spread": "^7.8.3",
     "@babel/preset-env": "^7.8.3",
     "@rollup/plugin-babel": "^6.0.3",
-    "@types/node": "^18.14.0",
+    "@types/node": "^20.0.0",
     "@vitejs/plugin-legacy": "^3.0.1",
     "chai": "^4.2.0",
     "concurrently": "^7.6.0",
@@ -65,9 +65,9 @@
     "shx": "^0.3.4",
     "sinon": "^7.5.0",
     "terser": "^5.16.8",
-    "tsd": "^0.21.0",
-    "typedoc": "^0.23.21",
-    "typescript": "^4.9.5",
+    "tsd": "^0.31.2",
+    "typedoc": "^0.27.5",
+    "typescript": "~5.3.3",
     "vite": "^4.0.4",
     "vitest": "^0.27.2"
   }
diff --git a/src/components/BloomComponent.d.mts b/src/components/BloomComponent.d.mts
@@ -49,7 +49,6 @@ declare namespace BloomComponent {
 declare class BloomComponent<ContentType extends Element = Element>
   extends Component<BloomComponent.TemplateSpec<ContentType>>
 {
-  // @ts-expect-error Prevent ts(2380)
   get content(): ContentType;
   set content(v: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);
 
diff --git a/src/components/BorderComponent.d.mts b/src/components/BorderComponent.d.mts
@@ -128,7 +128,6 @@ declare namespace BorderComponent {
 declare class BorderComponent<ContentType extends Element = Element>
   extends Component<BorderComponent.TemplateSpec<ContentType>>
 {
-  // @ts-expect-error Prevent ts(2380)
   get content(): ContentType;
   set content(v: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);
 
diff --git a/src/components/FastBlurComponent.d.mts b/src/components/FastBlurComponent.d.mts
@@ -51,7 +51,6 @@ declare class FastBlurComponent<
 >
   extends Component<FastBlurComponent.TemplateSpec<ContentType>>
 {
-  // @ts-expect-error Prevent ts(2380)
   get content(): ContentType;
   set content(v: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);
 
diff --git a/src/components/SmoothScaleComponent.d.mts b/src/components/SmoothScaleComponent.d.mts
@@ -37,7 +37,6 @@ declare class SmoothScaleComponent<
 >
   extends Component<SmoothScaleComponent.TemplateSpec<ContentType>>
 {
-  // @ts-expect-error Prevent ts(2380)
   get content(): ContentType;
   set content(content: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);
   smoothScale: number;
diff --git a/src/index.ts b/src/index.ts
@@ -75,6 +75,7 @@ import C2dBlurShader from "./renderer/c2d/shaders/BlurShader.mjs";
 import SpinnerShader2 from "./renderer/webgl/shaders/SpinnerShader2.mjs";
 
 import Stage from "./tree/Stage.mjs";
+import WebPlatform from "./platforms/browser/WebPlatform.mjs";
 
 // full export (no tree-shaking)
 import lng from "./lightning.mjs";
@@ -135,4 +136,7 @@ export {
   ObjMerger,
   ObjectListProxy,
   ObjectListWrapper,
+  WebPlatform,
 };
+
+export type * from './types/lng.types.namespace.mjs';
diff --git a/src/platforms/browser/WebPlatform.d.mts b/src/platforms/browser/WebPlatform.d.mts
@@ -18,6 +18,7 @@
  */
 import Stage from "../../tree/Stage.mjs";
 import TextureSource from "../../tree/TextureSource.mjs";
+import type StaticCanvasTexture from "../../textures/StaticCanvasTexture.mjs";
 
 export default class WebPlatform {
   destroy(): void;
@@ -41,4 +42,5 @@ export default class WebPlatform {
     options: unknown,
   ): void;
   getHrTime(): number;
+  createSvg?: (cb: StaticCanvasTexture.FactoryCallback, stage: Stage, url: string, w: number, h: number) => void;
 }
diff --git a/src/textures/TextTexture.d.mts b/src/textures/TextTexture.d.mts
@@ -19,6 +19,7 @@
 import Stage from "../tree/Stage.mjs";
 import Texture from "../tree/Texture.mjs";
 import TextTextureRenderer from "./TextTextureRenderer.mjs";
+import TextTextureRendererAdvanced from "./TextTextureRendererAdvanced.mjs";
 
 declare namespace TextTexture {
   /**
@@ -456,8 +457,8 @@ declare class TextTexture extends Texture implements Required<Omit<TextTexture.S
   protected static renderer(
     stage: Stage,
     canvas: HTMLCanvasElement,
-    settings: TextTexture.Settings,
-  ): TextTextureRenderer;
+    settings: TextTexture.Settings
+  ): TextTextureRenderer | TextTextureRendererAdvanced;
 
   // protected _changed(): void;
   // protected stage: Stage;
diff --git a/src/textures/TextTexture.mjs b/src/textures/TextTexture.mjs
@@ -30,7 +30,7 @@ export default class TextTexture extends Texture {
     }
 
     static renderer(stage, canvas, settings) {
-        if (this.advancedRenderer) {
+        if (settings.advancedRenderer) {
             return new TextTextureRendererAdvanced(stage, canvas, settings);
         } else {
             return new TextTextureRenderer(stage, canvas, settings);
@@ -549,9 +549,7 @@ export default class TextTexture extends Texture {
 
         return function (cb) {
             const canvas = this.stage.platform.getDrawingCanvas();
-            const renderer = (args.advancedRenderer)
-              ? new TextTextureRendererAdvanced(this.stage, canvas, args)
-              : new TextTextureRenderer(this.stage, canvas, args);
+            const renderer = TextTexture.renderer(this.stage, canvas, args);
             
             const p = renderer.draw();
 
diff --git a/src/textures/TextTextureRendererAdvanced.d.mts b/src/textures/TextTextureRendererAdvanced.d.mts
@@ -0,0 +1,63 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2022 Metrological
+ *
+ * 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 Stage from "../tree/Stage.mjs";
+import TextureSource from "../tree/TextureSource.mjs";
+import TextTexture from "./TextTexture.mjs";
+
+declare namespace TextTextureRendererAdvanced {
+  export interface WordInfo {
+    text: string;
+    bold: boolean;
+    italic: boolean;
+    color: string;
+    width?: number;
+  }
+}
+
+declare class TextTextureRendererAdvanced {
+  constructor(
+    stage: Stage,
+    canvas: HTMLCanvasElement,
+    settings: Required<TextTexture.Settings>,
+  );
+  
+  private _settings: Required<TextTexture.Settings>;
+  renderInfo?: TextureSource.RenderInfo;
+
+  _calculateRenderInfo(): TextureSource.RenderInfo;
+  _context: CanvasRenderingContext2D;
+  getPrecision(): number;
+  setFontProperties(): void;
+  _load(): Promise<void> | undefined;
+  draw(): Promise<void> | undefined;
+  _draw(): void;
+  measureText(word: string, space?: number): number;
+  tokenize(text: string): string[];
+  parse(tokens: string[]): string[];
+  applyFontStyle(word: string, baseFont: string): void;
+  resetFontStyle(baseFont: string): void;
+  measure(
+    parsed: TextTextureRendererAdvanced.WordInfo[],
+    letterSpacing: number,
+    baseFont: string
+  ): TextTextureRendererAdvanced.WordInfo[];
+  indent(parsed: TextTextureRendererAdvanced.WordInfo[], textIndent: number): TextTextureRendererAdvanced.WordInfo[];
+}
+
+export default TextTextureRendererAdvanced;
diff --git a/src/tools/Tools.d.mts b/src/tools/Tools.d.mts
@@ -17,6 +17,7 @@
  * limitations under the License.
  */
 import StaticCanvasTexture from "../textures/StaticCanvasTexture.mjs";
+import Stage from "../tree/Stage.mjs";
 
 declare namespace Tools {
   export type CornerRadius = number | [number, number, number, number];
@@ -112,8 +113,16 @@ declare class Tools {
     h: number
   ): StaticCanvasTexture.Settings;
 
-  // static createSvg(cb, stage, url, w, h) {
-  // - This returns an HTML Canvas element and is used privately by getSvgTexture
+  /**
+   * This returns an HTML Canvas element and is used privately by getSvgTexture
+   * 
+   * @param cb 
+   * @param stage 
+   * @param url 
+   * @param w 
+   * @param h 
+   */
+  static createSvg(cb: StaticCanvasTexture.FactoryCallback, stage: Stage, url: string, w: number, h: number): void;
 }
 
 export default Tools;
diff --git a/src/tree/Element.d.mts b/src/tree/Element.d.mts
@@ -1795,9 +1795,6 @@ declare class Element<
    *
    * @see {@link Element.TemplateSpec.transitions}
    */
-  // The getter type needs to have TransitionsTemplate in its union for some reason thats not clear
-  // @ts-ignore-error Prevent ts(2380)
-  get transitions(): TransitionsTemplate<TemplateSpecType> | undefined;
   set transitions(v: TransitionsTemplate<TemplateSpecType>);
 
   /**
@@ -1817,9 +1814,6 @@ declare class Element<
    *
    * @see {@link Element.TemplateSpec.smooth}
    */
-  // The getter type needs to have SmoothTemplate in its union for some reason thats not clear
-  // @ts-ignore-error Prevent ts(2380)
-  get smooth(): SmoothTemplate<TemplateSpecType> | undefined;
   set smooth(object: SmoothTemplate<TemplateSpecType>);
 
   /**
@@ -1890,7 +1884,7 @@ declare class Element<
     property: Key,
     value: number extends TemplateSpecType[Key] ? number : never,
     settings?: TransitionSettings.Literal,
-  ): void;
+  ): Transition;
 
   flex: Element.Flex;
 
diff --git a/src/tree/ObjectList.d.mts b/src/tree/ObjectList.d.mts
@@ -79,6 +79,13 @@ export default class ObjectList<ItemType, LiteralType extends Record<string | nu
    * @returns Item if `index` is greather than/equal to 0 and less than {@link length}, otherwise undefined.
    */
   getAt(index: number): ItemType | undefined;
+  /**
+   * Find index of `object` in the ObjectList by strict equality
+   *
+   * @param object
+   * @returns Index of item, or -1 if not found
+   */
+  getIndex(object: ItemType): number;
   /**
    * Get item by ref string
    *
diff --git a/src/tree/Stage.d.mts b/src/tree/Stage.d.mts
@@ -18,8 +18,8 @@
  */
 import AnimationManager from "../animation/AnimationManager.mjs";
 import TransitionManager from "../animation/TransitionManager.mjs";
-import Application from "../application/Application.mjs";
-import Component from "../application/Component.mjs";
+import type Application from "../application/Application.mjs";
+import type Component from "../application/Component.mjs";
 import EventEmitter from "../EventEmitter.mjs";
 import WebPlatform from "../platforms/browser/WebPlatform.mjs";
 import C2dRenderer from "../renderer/c2d/C2dRenderer.mjs";
@@ -285,6 +285,7 @@ declare namespace Stage {
     frameStart: () => void;
     update: () => void;
     frameEnd: () => void;
+    idle: () => void;
   }
 }
 
diff --git a/src/tree/Texture.d.mts b/src/tree/Texture.d.mts
@@ -187,6 +187,8 @@ declare class Texture {
   mh: number;
   mw: number;
   resizeMode: Texture.ResizeMode;
+  enableClipping(x: number, y: number, w: number, h: number): void;
+  disableClipping(): void;
   readonly stage: Stage;
   source: TextureSource | null;
   _source: TextureSource | null;
@@ -211,7 +213,7 @@ declare class Texture {
 
   protected _getIsValid(): boolean;
   protected _getLookupId(): string | null;
-  protected _getSourceLoader(): Texture.SourceLoaderCallback;
+  protected _getSourceLoader(): TextureSource.Loader;
 
   _changed(): void;
   addElement(el: Element): void;
diff --git a/src/tree/TextureSource.d.mts b/src/tree/TextureSource.d.mts
@@ -38,18 +38,19 @@ declare namespace TextureSource {
     premultiplyAlpha: boolean;
     renderInfo: RenderInfo;
     source: NativeTexture;
+    throttle: boolean;
     w: number;
   }
 
   export type LoaderCallback = (
     err: Error | null,
     options?: LoadOptions,
-  ) => LoadCancelCallback;
+  ) => void;
 
   export type Loader = (
     callback: LoaderCallback,
     source: TextureSource,
-  ) => void;
+  ) => LoadCancelCallback;
 
   export interface RenderInfo<T = string[]> {
     cutEx: number;
diff --git a/src/tree/core/ElementCore.d.mts b/src/tree/core/ElementCore.d.mts
@@ -131,6 +131,7 @@ declare class ElementCore {
   disableFuncW(): void;
   getCornerPoints(): [number, number, number, number, number, number, number, number];
   getRenderTextureCoords(relX: number, relY: number): [number, number];
+  getAbsoluteCoords(relX: number, relY: number): [number, number];
   getRenderHeight(): number;
   getRenderWidth(): number;
   inBound(tx: number, ty: number): boolean;
diff --git a/src/types/lng.types.namespace.d.mts b/src/types/lng.types.namespace.d.mts
@@ -35,6 +35,7 @@ import WebGLCoreQuadList from "../renderer/webgl/WebGLCoreQuadList.mjs";
 import WebGLCoreQuadOperation from "../renderer/webgl/WebGLCoreQuadOperation.mjs";
 import WebGLRenderer from "../renderer/webgl/WebGLRenderer.mjs";
 import TextTextureRenderer from "../textures/TextTextureRenderer.mjs";
+import TextTextureRendererAdvanced from "../textures/TextTextureRendererAdvanced.mjs";
 import CoreContext from "../tree/core/CoreContext.mjs";
 import CoreQuadList from "../tree/core/CoreQuadList.mjs";
 import CoreQuadOperation from "../tree/core/CoreQuadOperation.mjs";
@@ -59,6 +60,7 @@ export {
   TextureManager,
   TextureSource,
   TextTextureRenderer,
+  TextTextureRendererAdvanced,
   CoreContext,
   CoreRenderState,
   CoreQuadOperation,

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,6 @@ declare namespace BloomComponent {`
`49`	`49`	`declare class BloomComponent<ContentType extends Element = Element>`
`50`	`50`	`extends Component<BloomComponent.TemplateSpec<ContentType>>`
`51`	`51`	`{`
`52`		`- // @ts-expect-error Prevent ts(2380)`
`53`	`52`	`get content(): ContentType;`
`54`	`53`	`set content(v: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);`
`55`	`54`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,6 @@ declare namespace BorderComponent {`
`128`	`128`	`declare class BorderComponent<ContentType extends Element = Element>`
`129`	`129`	`extends Component<BorderComponent.TemplateSpec<ContentType>>`
`130`	`130`	`{`
`131`		`- // @ts-expect-error Prevent ts(2380)`
`132`	`131`	`get content(): ContentType;`
`133`	`132`	`set content(v: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);`
`134`	`133`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,6 @@ declare class FastBlurComponent<`
`51`	`51`	`>`
`52`	`52`	`extends Component<FastBlurComponent.TemplateSpec<ContentType>>`
`53`	`53`	`{`
`54`		`- // @ts-expect-error Prevent ts(2380)`
`55`	`54`	`get content(): ContentType;`
`56`	`55`	`set content(v: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);`
`57`	`56`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,6 @@ declare class SmoothScaleComponent<`
`37`	`37`	`>`
`38`	`38`	`extends Component<SmoothScaleComponent.TemplateSpec<ContentType>>`
`39`	`39`	`{`
`40`		`- // @ts-expect-error Prevent ts(2380)`
`41`	`40`	`get content(): ContentType;`
`42`	`41`	`set content(content: Element.PatchTemplate<Element.ExtractTemplateSpec<ContentType>>);`
`43`	`42`	`smoothScale: number;`