@kosdev-code/kos-ui-sdk 2.0.39 → 2.0.40

package/models/models/canvas-dispatcher/types/index.d.ts

@@ -25,7 +25,14 @@ declare interface OneShotCapable extends DoneAware {
 
 declare type RendererOptions = "sweep" | "matrix" | "video" | "drop" | "none";
 
-declare type RendererMode = "video" | "image" | "color" | "sequence" | "matrix" | "text";
+declare type RendererMode =
+  | "video"
+  | "image"
+  | "color"
+  | "sequence"
+  | "matrix"
+  | "text"
+  | "overlay";
 declare interface RenderSpecification<T extends RendererMode> {
   type: T;
   id: string;
@@ -104,6 +111,40 @@ declare interface TextRenderDataSpecification {
   };
 }
 
+declare type OverlayPosition =
+  | "top-left"
+  | "top-center"
+  | "top-right"
+  | "center-left"
+  | "center"
+  | "center-right"
+  | "bottom-left"
+  | "bottom-center"
+  | "bottom-right";
+
+declare interface OverlayCustomPosition {
+  x: number;
+  y: number;
+}
+
+declare interface OverlayIconConfig {
+  src: string; // Image source for the overlay icon
+  size: number; // Size of the overlay icon (width and height)
+  position: OverlayPosition | OverlayCustomPosition; // Position of the overlay
+  offset?: { x?: number; y?: number }; // Optional offset from the position in pixels
+  opacity?: number; // Optional opacity (0-1)
+  persistent?: boolean; // Whether the overlay should always be visible (default: true)
+}
+
+declare interface OverlayRenderDataSpecification {
+  baseRenderer: {
+    type: string;
+    data: any;
+  }; // The base renderer configuration
+  overlays: OverlayIconConfig[]; // Array of overlay icons to display
+  persistOverlaysOnComplete?: boolean; // Whether overlays remain visible after base renderer completes (default: true)
+}
+
 declare type RenderDataSpecification<T extends RendererMode> = T extends "video"
   ? VideoRenderDataSpecification
   : T extends "image"
@@ -116,6 +157,8 @@ declare type RenderDataSpecification<T extends RendererMode> = T extends "video"
   ? MatrixRenderDataSpecification
   : T extends "text"
   ? TextRenderDataSpecification
+  : T extends "overlay"
+  ? OverlayRenderDataSpecification
   : any;
 
 declare type VideoRenderData = RenderSpecification<"video">;
@@ -128,12 +171,15 @@ declare type MatrixRenderData = RenderSpecification<"matrix">;
 
 declare type TextRenderData = RenderSpecification<"text">;
 
+declare type OverlayRenderData = RenderSpecification<"overlay">;
+
 declare type RenderData =
   | VideoRenderData
   | ImageRenderData
   | ColorRenderData
   | MatrixRenderData
   | TextRenderData
+  | OverlayRenderData
   | any;
 
 declare interface EndpointData {

package/models/models/canvas-dispatcher/utils/renderers/overlay-renderer.d.ts

@@ -0,0 +1,76 @@
+import { DoneAware, Renderer } from '../../types';
+
+/**
+ * Predefined overlay positions for easy positioning
+ */
+export type OverlayPosition = "top-left" | "top-center" | "top-right" | "center-left" | "center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+/**
+ * Custom positioning with explicit coordinates
+ */
+export interface OverlayCustomPosition {
+    x: number;
+    y: number;
+}
+/**
+ * Configuration for a single overlay icon
+ */
+export interface OverlayIconConfig {
+    /** Image source for the overlay icon */
+    src: string;
+    /** Size of the overlay icon (width and height) */
+    size: number;
+    /** Position of the overlay - either predefined name or custom coordinates */
+    position: OverlayPosition | OverlayCustomPosition;
+    /** Optional offset from the position in pixels */
+    offset?: {
+        x?: number;
+        y?: number;
+    };
+    /** Optional opacity (0-1) */
+    opacity?: number;
+    /** Whether the overlay should always be visible (default: true) */
+    persistent?: boolean;
+}
+/**
+ * Configuration for overlay renderer
+ */
+export interface OverlayRenderDataSpecification {
+    /** The base renderer configuration */
+    baseRenderer: {
+        type: string;
+        data: any;
+    };
+    /** Array of overlay icons to display */
+    overlays: OverlayIconConfig[];
+    /** Whether overlays should remain visible after base renderer completes (default: true) */
+    persistOverlaysOnComplete?: boolean;
+}
+/**
+ * A renderer that wraps another renderer and adds static overlay icons
+ * that are not affected by scrolling, scaling, or other transformations.
+ */
+export declare class OverlayRenderer implements Renderer, DoneAware {
+    private baseRenderer;
+    private overlayIcons;
+    private overlayConfigs;
+    private loadedIcons;
+    private canvas;
+    private ctx;
+    private persistOverlaysOnComplete;
+    private baseRendererCompleted;
+    private completionCallback;
+    private hasSignaledCompletion;
+    constructor(data: OverlayRenderDataSpecification, rendererFactory: (type: string, data: any) => Renderer);
+    private loadOverlayImages;
+    private calculateOverlayPosition;
+    reset(): void;
+    renderFrame(width: number, height: number): void;
+    private renderOverlays;
+    readPixels(width: number, height: number): Uint8ClampedArray;
+    play?(): void;
+    pause?(): void;
+    dispose?(): void;
+    onDone(callback: () => void): void;
+    isOneShot?(): boolean;
+}
+//# sourceMappingURL=overlay-renderer.d.ts.map

package/models/models/canvas-dispatcher/utils/renderers/overlay-renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-renderer.d.ts","sourceRoot":"","sources":["../../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/canvas-dispatcher/utils/renderers/overlay-renderer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAgC,QAAQ,EAAE,MAAM,aAAa,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,UAAU,GACV,YAAY,GACZ,WAAW,GACX,aAAa,GACb,QAAQ,GACR,cAAc,GACd,aAAa,GACb,eAAe,GACf,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,QAAQ,EAAE,eAAe,GAAG,qBAAqB,CAAC;IAClD,kDAAkD;IAClD,MAAM,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,sCAAsC;IACtC,YAAY,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,GAAG,CAAC;KACX,CAAC;IACF,wCAAwC;IACxC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,2FAA2F;IAC3F,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,eAAgB,YAAW,QAAQ,EAAE,SAAS;IACzD,OAAO,CAAC,YAAY,CAAW;IAC/B,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,cAAc,CAAsB;IAC5C,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,GAAG,CAA2B;IACtC,OAAO,CAAC,yBAAyB,CAAU;IAC3C,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,kBAAkB,CAA6B;IACvD,OAAO,CAAC,qBAAqB,CAAS;gBAE1B,IAAI,EAAE,8BAA8B,EAAE,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,QAAQ;YA2B1F,iBAAiB;IAkB/B,OAAO,CAAC,wBAAwB;IAkEhC,KAAK,IAAI,IAAI;IAMb,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAgChD,OAAO,CAAC,cAAc;IAmCtB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,iBAAiB;IAK5D,IAAI,CAAC,IAAI,IAAI;IAMb,KAAK,CAAC,IAAI,IAAI;IAMd,OAAO,CAAC,IAAI,IAAI;IAgBhB,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IASlC,SAAS,CAAC,IAAI,OAAO;CAYtB"}

package/models/models/canvas-dispatcher/utils/renderers/renderer-factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer-factory.d.ts","sourceRoot":"","sources":["../../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/canvas-dispatcher/utils/renderers/renderer-factory.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,uBAAuB,EACvB,QAAQ,EAER,YAAY,EACb,MAAM,aAAa,CAAC;AA+DrB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,WAAW,4CAGrB;IACD,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,CAAC,EAAE,wBAAwB,CAAC,CAAC,GAAG,IAAI,CAAC;CAC1C,KAAG,QAAQ,GAAG,IAQd,CAAC"}
+{"version":3,"file":"renderer-factory.d.ts","sourceRoot":"","sources":["../../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/canvas-dispatcher/utils/renderers/renderer-factory.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,uBAAuB,EACvB,QAAQ,EAER,YAAY,EACb,MAAM,aAAa,CAAC;AAmGrB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,WAAW,4CAGrB;IACD,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,CAAC,EAAE,wBAAwB,CAAC,CAAC,GAAG,IAAI,CAAC;CAC1C,KAAG,QAAQ,GAAG,IAQd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kosdev-code/kos-ui-sdk",
-  "version": "2.0.39",
+  "version": "2.0.40",
   "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",
@@ -36,7 +36,7 @@
   },
   "kos": {
     "build": {
-      "gitHash": "335ce8a059d94cf2db2d6d483aa048ccc52dc70e"
+      "gitHash": "e892e3567f1518d84fb37df390a1b23e5bc40ccd"
     }
   }
 }