@yamcs/opi 1.3.4 → 1.3.6

package/dist/types/Display.d.ts

@@ -2,7 +2,7 @@ import { Color } from "./Color";
 import { ConsoleHandler } from "./ConsoleHandler";
 import { DialogHandler } from "./DialogHandler";
 import { FontResolver } from "./FontResolver";
-import { Formatter } from './Formatter';
+import { Formatter } from "./Formatter";
 import { PathResolver } from "./PathResolver";
 import { Widget } from "./Widget";
 import { OPIEvent, OPIEventMap } from "./events";

package/dist/types/Widget.d.ts

@@ -25,7 +25,7 @@ export declare abstract class Widget {
     readonly vars: Map<string, any>;
     private pvs;
     constructor(display: Display, parent?: AbstractContainerWidget | undefined);
-    parseNode(node: XMLNode): void;
+    parseNode(node: XMLNode): Promise<void>;
     getHookedActions(): Action[];
     drawHolder(g: Graphics): void;
     beforeDrawBorder(g: Graphics): void;

package/dist/types/index.d.ts

@@ -6,10 +6,11 @@ export { Font } from "./Font";
 export { FontResolver } from "./FontResolver";
 export { DefaultPathResolver, PathResolver } from "./PathResolver";
 export { Dimension, NullablePoint, Point } from "./positioning";
-export { CompiledFormula, DataSourceStatus } from "./pv/formulas/CompiledFormula";
+export { CompiledFormula, DataSourceStatus, } from "./pv/formulas/CompiledFormula";
 export { FormulaCompiler } from "./pv/formulas/FormulaCompiler";
 export { HistoricalDataProvider } from "./pv/HistoricalDataProvider";
 export { AlarmSeverity, PV } from "./pv/PV";
 export { PVProvider } from "./pv/PVProvider";
 export { Sample } from "./pv/Sample";
+export { TypeHint } from "./pv/TypeHint";
 export { Widget } from "./Widget";

package/dist/types/pv/PV.d.ts

@@ -1,12 +1,14 @@
 import { PVEngine } from "./PVEngine";
 import { PVProvider } from "./PVProvider";
 import { Sample } from "./Sample";
+import { TypeHint } from "./TypeHint";
 export declare class PV {
     readonly name: string;
     readonly pvEngine: PVEngine;
     private _writable;
     private _units?;
     private _labels?;
+    private _typeHint?;
     private _lowerDisplayLimit?;
     private _lowerAlarmLimit?;
     private _lowerWarningLimit?;
@@ -48,6 +50,7 @@ export declare class PV {
     get value(): any | undefined;
     get indexValue(): number | undefined;
     get severity(): AlarmSeverity;
+    get typeHint(): TypeHint | undefined;
     get alarmName(): string;
     toNumber(): number | null | undefined;
     setSample(sample: Sample): void;

package/dist/types/pv/PVProvider.d.ts

@@ -1,4 +1,4 @@
-import { Widget } from '../Widget';
+import { Widget } from "../Widget";
 import { HistoricalDataProvider } from "./HistoricalDataProvider";
 import { PV } from "./PV";
 export interface PVProvider {

package/dist/types/pv/Sample.d.ts

@@ -1,4 +1,5 @@
 import { AlarmSeverity } from "./PV";
+import { TypeHint } from "./TypeHint";
 export interface Sample {
     time: Date;
     value: any;
@@ -12,4 +13,9 @@ export interface Sample {
      * Engineering units
      */
     units?: string;
+    /**
+     * Optional type hint for values that are
+     * not JavaScript primitives.
+     */
+    typeHint?: TypeHint;
 }

package/dist/types/pv/SystemPVProvider.d.ts

@@ -1,4 +1,4 @@
-import { Formatter } from '../Formatter';
+import { Formatter } from "../Formatter";
 import { PV } from "./PV";
 import { PVProvider } from "./PVProvider";
 export declare class SystemPVProvider implements PVProvider {

package/dist/types/pv/TypeHint.d.ts

@@ -0,0 +1,5 @@
+export type TypeHint = 
+/**
+ * Value is a binary string containing raw bytes.
+ */
+"BINARY_STRING";

package/dist/types/pv/sim.d.ts

@@ -1,4 +1,4 @@
-import { Formatter } from '../Formatter';
+import { Formatter } from "../Formatter";
 import { PV } from "./PV";
 export declare abstract class SimGenerator {
     readonly pv: PV;

package/dist/types/scripting/PVUtil.d.ts

@@ -1,4 +1,4 @@
-import { Display } from '../Display';
+import { Display } from "../Display";
 import { PVWrapper } from "./PVWrapper";
 import { WidgetWrapper } from "./WidgetWrapper";
 export declare class PVUtil {

package/dist/types/utils.d.ts

@@ -1,3 +1,4 @@
+import { TypeHint } from "./pv/TypeHint";
 export declare function roundRect(ctx: CanvasRenderingContext2D, x: number, y: number, w: number, h: number, rx: number, ry: number): void;
 export declare function normalizePath(base: string, relPath: string): string;
-export declare function formatValue(value: any, formatType: number, precision: number): string;
+export declare function formatValue(value: any, formatType: number, precision: number, typeHint: TypeHint | undefined): string;

package/dist/types/widgets/monitors/LED.d.ts

@@ -9,7 +9,7 @@ export declare class LED extends Widget {
     private areaRegion?;
     private states;
     constructor(display: Display, parent: AbstractContainerWidget);
-    parseNode(node: XMLNode): void;
+    parseNode(node: XMLNode): Promise<void>;
     init(): void;
     get booleanValue(): boolean;
     get bulbColor(): Color;

package/dist/types/widgets/others/Connection.d.ts

@@ -8,7 +8,7 @@ export declare class Connection extends Widget {
     private sourceWidget?;
     private targetWidget?;
     constructor(display: Display);
-    parseNode(node: XMLNode): void;
+    parseNode(node: XMLNode): Promise<void>;
     draw(g: Graphics): void;
     private drawPath;
     private drawManhattanConnection;

package/dist/types/widgets/others/DisplayWidget.d.ts

@@ -9,7 +9,7 @@ export declare class DisplayWidget extends AbstractContainerWidget {
     constructor(display: Display, parent?: AbstractContainerWidget, args?: {
         [key: string]: string;
     });
-    parseNode(node: XMLNode): void;
+    parseNode(node: XMLNode): Promise<void>;
     draw(g: Graphics): void;
     measureContentBounds(scaled: boolean): Bounds;
     get autoScaleWidgets(): AutoScaleWidgets;

package/dist/types/widgets/others/GroupingContainer.d.ts

@@ -2,7 +2,7 @@ import { Graphics } from "../../Graphics";
 import { XMLNode } from "../../XMLNode";
 import { AbstractContainerWidget } from "./AbstractContainerWidget";
 export declare class GroupingContainer extends AbstractContainerWidget {
-    parseNode(node: XMLNode): void;
+    parseNode(node: XMLNode): Promise<void>;
     beforeDrawBorder(g: Graphics): void;
     draw(g: Graphics): void;
 }

package/dist/types/widgets/others/LinkingContainer.d.ts

@@ -6,8 +6,8 @@ export declare class LinkingContainer extends AbstractContainerWidget {
     private linkedDisplay?;
     resolvedOpiFile?: string;
     constructor(display: Display, parent: AbstractContainerWidget);
-    parseNode(node: XMLNode): void;
-    init(): void;
+    parseNode(node: XMLNode): Promise<void>;
+    init(): Promise<void>;
     draw(g: Graphics): void;
     getLinkedWidget(): import("../..").Widget | undefined;
     get widgets(): import("../..").Widget[];

package/dist/types/widgets/others/TabbedContainer.d.ts

@@ -6,7 +6,7 @@ import { AbstractContainerWidget } from "./AbstractContainerWidget";
 export declare class TabbedContainer extends AbstractContainerWidget {
     private tabs;
     constructor(display: Display, parent: AbstractContainerWidget);
-    parseNode(node: XMLNode): void;
+    parseNode(node: XMLNode): Promise<void>;
     draw(g: Graphics): void;
     measureTabOffset(g: Graphics): Point;
     private measureLabelHeight;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamcs/opi",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "description": "OPI Display Renderer",
   "author": "Yamcs Team <yamcs@spaceapplications.com>",
   "repository": {
@@ -16,7 +16,9 @@
     "prepublishOnly": "npm run build",
     "watch": "esbuild src/index.ts --outfile=dist/opi.js --sourcemap --bundle --platform=browser --format=esm --minify --watch",
     "peggy": "cd src/pv/formulas && peggy --format es -o parser.js formula-grammar.peggy",
-    "start": "node ./demo/server.js"
+    "start": "node ./demo/server.js",
+    "prettier:check": "prettier --check '**/*.ts'",
+    "prettier:write": "prettier --check --write '**/*.ts'"
   },
   "module": "dist/opi.js",
   "types": "dist/types/index.d.ts",
@@ -31,6 +33,7 @@
     "morgan": "^1.10.0",
     "nunjucks": "^3.2.2",
     "peggy": "4.2.0",
+    "prettier": "^3.5.3",
     "tslib": "^2.6.3",
     "typescript": "^5.4.5"
   }