@yamcs/opi 1.4.2 → 1.4.4

package/dist/types/DialogHandler.d.ts

@@ -4,8 +4,14 @@ export interface DialogHandler {
     openWarningDialog(title: string, message: string): void;
     openErrorDialog(title: string, message: string): void;
     openPasswordDialog(title: string, message: string, password: string): boolean;
+    openConfirmDialogAsync?(title: string, message: string): Promise<boolean>;
+    openPasswordDialogAsync?(title: string, message: string, password: string): Promise<boolean>;
 }
+export declare function confirmAsync(dialogHandler: DialogHandler, title: string, message: string): Promise<boolean>;
+export declare function passwordAsync(dialogHandler: DialogHandler, title: string, message: string, password: string): Promise<boolean>;
 export declare class DefaultDialogHandler implements DialogHandler {
+    openConfirmDialogAsync(title: string, message: string): Promise<boolean>;
+    openPasswordDialogAsync(title: string, message: string, password: string): Promise<boolean>;
     openConfirmDialog(title: string, message: string): boolean;
     openInformationDialog(title: string, message: string): void;
     openWarningDialog(title: string, message: string): void;

package/dist/types/Display.d.ts

@@ -78,6 +78,7 @@ export declare class Display {
     private imageLoader;
     private consoleHandler;
     private dialogHandler;
+    private pendingTask?;
     formatter: Formatter;
     private repaintRequested;
     private _editMode;
@@ -127,6 +128,14 @@ export declare class Display {
     getConsoleHandler(): ConsoleHandler;
     setDialogHandler(dialogHandler: DialogHandler): void;
     getDialogHandler(): DialogHandler;
+    /**
+     * Runs a user-triggered task (an action, a confirmed write). A task may
+     * wait on a non-blocking dialog by returning a promise. Tasks run in
+     * order: while one is waiting, later tasks wait too, as they would behind
+     * a blocking dialog. Without a waiting task, a task runs immediately.
+     */
+    runSequenced(task: () => void | Promise<void>): void;
+    private trackTask;
     setFontResolver(fontResolver: FontResolver): void;
     getFontResolver(): FontResolver | undefined;
     private step;
@@ -137,7 +146,7 @@ export declare class Display {
      */
     requestRepaint(): void;
     setTooltip(tooltip: string | undefined): void;
-    createWidget(kind: string, parent: AbstractContainerWidget): ActionButton | Arc | ArrayWidget | BooleanButton | BooleanSwitch | ByteMonitor | CheckBox | ChoiceButton | Combo | Ellipse | Gauge | GridLayout | GroupingContainer | ImageBooleanButton | ImageBooleanIndicator | ImageWidget | IntensityGraph | Knob | LED | Label | LinkingContainer | MenuButton | Meter | Polygon | Polyline | ProgressBar | RadioBox | Rectangle | RoundedRectangle | SashContainer | ScaledSlider | Scrollbar | Spinner | TabbedContainer | Table | Tank | TextInput | TextUpdate | Thermometer | ThumbWheel | WebBrowser | XYGraph | undefined;
+    createWidget(kind: string, parent: AbstractContainerWidget): ArrayWidget | ActionButton | Arc | BooleanButton | BooleanSwitch | ByteMonitor | CheckBox | ChoiceButton | Combo | Ellipse | Gauge | GridLayout | GroupingContainer | ImageWidget | ImageBooleanButton | ImageBooleanIndicator | IntensityGraph | Knob | Label | LED | LinkingContainer | MenuButton | Meter | Polygon | Polyline | ProgressBar | RadioBox | Rectangle | RoundedRectangle | SashContainer | ScaledSlider | Scrollbar | Spinner | TabbedContainer | Table | Tank | TextInput | TextUpdate | Thermometer | ThumbWheel | WebBrowser | XYGraph | undefined;
     /**
      * Releases everything this Display holds outside of its own instance:
      * the repaint loop, the resize observer, canvas/document event
@@ -147,7 +156,21 @@ export declare class Display {
      * calls on a Display that keeps running.
      */
     destroy(): void;
+    /**
+     * Resolves a path as written in an OPI file. Relative paths are resolved
+     * against the OPI file that defines the widget (which may be a linked OPI
+     * in another folder), the same as Yamcs Studio.
+     *
+     * The result is an absolute URL, so it keeps its meaning when passed on
+     * (for example to a loader or to the host application).
+     */
     resolvePath(path: string, widget?: Widget): string;
+    /**
+     * Expresses a resolved URL as a path from the display root (absPrefix),
+     * for example "/folder/display.opi". Returns undefined if the URL is not
+     * located under the display root.
+     */
+    toRootPath(url: string): string | undefined;
     setSource(href: string, args?: {
         [key: string]: string;
     }): Promise<void>;

package/dist/types/PostMessageDialogHandler.d.ts

@@ -0,0 +1,15 @@
+import { DefaultDialogHandler } from "./DialogHandler";
+/**
+ * Shows non-blocking dialogs in the outer application, via postMessage.
+ *
+ * Blocking dialogs remain native browser dialogs (inherited), because only
+ * those can block the calling script.
+ */
+export declare class PostMessageDialogHandler extends DefaultDialogHandler {
+    private nextId;
+    private pending;
+    openConfirmDialogAsync(title: string, message: string): Promise<boolean>;
+    openPasswordDialogAsync(title: string, message: string, password: string): Promise<boolean>;
+    receiveResult(id: number, result: boolean): void;
+    private request;
+}

package/dist/types/actions/Action.d.ts

@@ -5,7 +5,7 @@ export declare abstract class Action {
     properties: PropertySet;
     constructor();
     parseNode(node: XMLNode): void;
-    abstract execute(widget: Widget): void;
+    abstract execute(widget: Widget): void | Promise<void>;
     get description(): string;
     getDescription(): string;
     getDefaultDescription(): string;

package/dist/types/actions/RunCommandAction.d.ts

@@ -2,7 +2,8 @@ import { Widget } from "../Widget";
 import { Action } from "./Action";
 export declare class RunCommandAction extends Action {
     constructor();
-    execute(widget: Widget): void;
+    execute(widget: Widget): Promise<void> | undefined;
+    private run;
     get command(): string;
     get args(): {
         [key: string]: string;

package/dist/types/actions/RunProcedureAction.d.ts

@@ -2,7 +2,8 @@ import { Widget } from "../Widget";
 import { Action } from "./Action";
 export declare class RunProcedureAction extends Action {
     constructor();
-    execute(widget: Widget): void;
+    execute(widget: Widget): Promise<void> | undefined;
+    private run;
     get procedure(): string;
     get args(): {
         [key: string]: string;

package/dist/types/actions/RunStackAction.d.ts

@@ -2,7 +2,8 @@ import { Widget } from "../Widget";
 import { Action } from "./Action";
 export declare class RunStackAction extends Action {
     constructor();
-    execute(widget: Widget): void;
+    execute(widget: Widget): Promise<void> | undefined;
+    private run;
     get path(): string;
     get confirmMessage(): string;
     getDefaultDescription(): string;

package/dist/types/actions/WritePVAction.d.ts

@@ -2,7 +2,8 @@ import { Widget } from "../Widget";
 import { Action } from "./Action";
 export declare class WritePVAction extends Action {
     constructor();
-    execute(widget: Widget): void;
+    execute(widget: Widget): Promise<void> | undefined;
+    private run;
     get pvName(): string;
     get value(): string;
     get timeout(): number;

package/dist/types/actions.d.ts

@@ -4,7 +4,7 @@ export declare class ActionSet {
     hookFirstActionToClick: boolean;
     hookAllActionsToClick: boolean;
     add(action: Action | null): void;
-    isClickable(): 0 | boolean;
+    isClickable(): boolean | 0;
     getAction(index: number): Action | null | undefined;
     toString(): string;
 }

package/dist/types/events.d.ts

@@ -21,6 +21,7 @@ export interface SelectionEvent extends OPIEvent {
  */
 export interface OpenDisplayEvent extends OPIEvent {
     path: string;
+    absolutePath?: string;
     replace: boolean;
     args?: {
         [key: string]: string;
@@ -51,6 +52,7 @@ export interface RunCommandEvent extends OPIEvent {
  */
 export interface RunStackEvent extends OPIEvent {
     path: string;
+    absolutePath?: string;
 }
 /**
  * A script or a button requested to run a procedure.

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export { FontResolver } from "./FontResolver";
 export { DefaultImageLoader, ImageLoader } from "./ImageLoader";
 export { DefaultPathResolver, PathResolver } from "./PathResolver";
 export { Dimension, NullablePoint, Point } from "./positioning";
+export { PostMessageDialogHandler } from "./PostMessageDialogHandler";
 export { PostMessageImageLoader } from "./PostMessageImageLoader";
 export { PostMessageScriptLoader } from "./PostMessageScriptLoader";
 export { CompiledFormula, DataSourceStatus, } from "./pv/formulas/CompiledFormula";

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

@@ -4,7 +4,7 @@ import { Sample } from "./Sample";
 export type LocalPVType = "VDouble" | "VDoubleArray" | "VString" | "VStringArray";
 export declare class LocalPV extends PV {
     type?: LocalPVType | undefined;
-    readonly initializer?: any;
-    constructor(name: string, pvEngine: PVEngine, type?: LocalPVType | undefined, initializer?: any);
+    readonly initializer?: any | undefined;
+    constructor(name: string, pvEngine: PVEngine, type?: LocalPVType | undefined, initializer?: any | undefined);
     setSample(sample: Sample): void;
 }

package/dist/types/pv/formulas/parser.d.ts

@@ -1,11 +1,11 @@
+declare const peg$allowedStartRules: string[];
 declare class peg$SyntaxError extends SyntaxError {
+    static buildMessage(expected: any, found: any): string;
+    constructor(message: any, expected: any, found: any, location: any);
     expected: any;
     found: any;
     location: any;
-    constructor(message: any, expected: any, found: any, location: any);
     format(sources: any): string;
-    static buildMessage(expected: any, found: any): string;
 }
 declare function peg$parse(input: any, options: any): any;
-declare const peg$allowedStartRules: string[];
 export { peg$allowedStartRules as StartRules, peg$SyntaxError as SyntaxError, peg$parse as parse };

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

@@ -1,6 +1,11 @@
 import { Display } from "../Display";
+import { ScriptEngine } from "./ScriptEngine";
+import { WidgetWrapper } from "./WidgetWrapper";
 export declare class FileUtil {
     private display;
-    constructor(display: Display);
-    readTextFile(filePath: string): string;
+    private scriptEngine;
+    constructor(display: Display, scriptEngine: ScriptEngine);
+    readTextFile(filePath: string, widget?: WidgetWrapper | null): string;
+    readTextFileAsync(filePath: string, widget: WidgetWrapper | null | undefined, onSuccess: (text: string) => void, onError?: (message: string) => void): void;
+    private fail;
 }

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

@@ -1,11 +1,15 @@
 import { Display } from "../Display";
+import { ScriptEngine } from "./ScriptEngine";
 export declare class GUIUtil {
     private display;
-    constructor(display: Display);
+    private scriptEngine;
+    constructor(display: Display, scriptEngine: ScriptEngine);
     fullScreen(): void;
     openConfirmDialog(message: string): boolean;
+    openConfirmDialogAsync(message: string, onResult: (confirmed: boolean) => void): void;
     openInformationDialog(message: string): void;
     openWarningDialog(message: string): void;
     openErrorDialog(message: string): void;
     openPasswordDialog(message: string, password: string): boolean;
+    openPasswordDialogAsync(message: string, password: string, onResult: (correct: boolean) => void): void;
 }

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

@@ -18,7 +18,7 @@ export declare function createJavaBridge(scriptEngine: ScriptEngine): {
             }) => void;
             Thread: {
                 (runnable: any): void;
-                sleep: (delay: number) => void;
+                sleep(delay: number): void;
             };
         };
         util: {

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

@@ -16,7 +16,7 @@ export declare class PVUtil {
     getStringArray(pv: PVWrapper): string[];
     getTimeInMilliseconds(pv: PVWrapper): number;
     getTimeString(pv: PVWrapper, format?: string): string | null;
-    getSeverity(pv: PVWrapper): -1 | 0 | 1 | 2;
+    getSeverity(pv: PVWrapper): 1 | 2 | 0 | -1;
     getSeverityString(pv: PVWrapper): string;
     getStatus(pv: PVWrapper): string;
     getUnits(pv: PVWrapper): string | null;

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

@@ -1,7 +1,8 @@
 import { Display } from "../Display";
+import { WidgetWrapper } from "./WidgetWrapper";
 export declare class ScriptUtil {
     private display;
     constructor(display: Display);
-    openOPI(widget: any, path: string, target: number, macrosInput: any): void;
+    openOPI(widget: WidgetWrapper | null, path: string, target: number, macrosInput: any): void;
     closeCurrentOPI(): void;
 }

package/dist/types/widgets/controls/BooleanButton.d.ts

@@ -11,6 +11,7 @@ export declare class BooleanButton extends Widget {
     constructor(display: Display, parent: AbstractContainerWidget);
     init(): void;
     private openConfirmDialog;
+    private confirmThen;
     private toggleOn;
     private toggleOff;
     get booleanValue(): boolean;

package/dist/types/widgets/controls/BooleanSwitch.d.ts

@@ -9,6 +9,7 @@ export declare class BooleanSwitch extends Widget {
     constructor(display: Display, parent: AbstractContainerWidget);
     init(): void;
     private openConfirmDialog;
+    private confirmThen;
     private toggleOn;
     private toggleOff;
     get booleanValue(): boolean;

package/dist/types/widgets/controls/ImageBooleanButton.d.ts

@@ -13,6 +13,7 @@ export declare class ImageBooleanButton extends Widget {
     constructor(display: Display, parent: AbstractContainerWidget);
     init(): void;
     private openConfirmDialog;
+    private confirmThen;
     private toggleOn;
     private toggleOff;
     get booleanValue(): boolean;

package/dist/types/widgets/controls/TextInput.d.ts

@@ -7,11 +7,18 @@ export declare class TextInput extends Widget {
     private areaRegion?;
     private inputEl?;
     private editing;
+    private confirming;
     private scratchCanvas?;
     private scratchCtx?;
     constructor(display: Display, parent: AbstractContainerWidget);
     init(): void;
     private clampToLimits;
+    /**
+     * Used when the PV has no value, or a string value. The text is written
+     * as-is, except when it is a decimal number outside of the configured
+     * limits. Then the nearest limit is written instead.
+     */
+    private coerceText;
     private finishEditing;
     private cancelInput;
     private computeDisplayText;

package/dist/types/widgets/graphics/Polygon.d.ts

@@ -7,8 +7,10 @@ import { AbstractContainerWidget } from "../others/AbstractContainerWidget";
 export declare class Polygon extends Widget {
     private zeroDegreePoints;
     private originPoints?;
+    private updatingPoints;
     constructor(display: Display, parent: AbstractContainerWidget);
     init(): void;
+    private setPointsInternal;
     private updateZeroDegreePoints;
     /**
      * Mirrors AbstractPolyModel#doScale() in the Java reference, which is a

package/dist/types/widgets/graphics/Polyline.d.ts

@@ -6,8 +6,10 @@ import { AbstractContainerWidget } from "../others/AbstractContainerWidget";
 export declare class Polyline extends Widget {
     private zeroDegreePoints;
     private originPoints?;
+    private updatingPoints;
     constructor(display: Display, parent: AbstractContainerWidget);
     init(): void;
+    private setPointsInternal;
     private updateZeroDegreePoints;
     /**
      * Mirrors AbstractPolyModel#doScale() in the Java reference, which is a
@@ -27,6 +29,10 @@ export declare class Polyline extends Widget {
      *    makes a keep_wh_ratio polyline barely move at all under
      *    non-uniform scaling, clustering near its design position instead
      *    of tracking the layout.
+     *
+     * originPoints must be latched *before* the base autoScale call below:
+     * that call writes x/y, which synchronously fires the x/y listeners
+     * above and translates PROP_POINTS as a side effect.
      */
     autoScale(widthRatio: number, heightRatio: number): void;
     draw(g: Graphics): void;

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

@@ -26,6 +26,16 @@ export declare class LinearScale {
     timeFormat: number;
     length: number;
     margin: number;
+    /**
+     * If true, the range is shifted by less than one pixel, such that a value
+     * keeps the same sub-pixel offset when the range scrolls. This avoids
+     * anti-aliasing flicker of scrolling plots.
+     */
+    snapToPixels: boolean;
+    /**
+     * Device pixels per coordinate unit, used by snapToPixels.
+     */
+    pixelRatio: number;
     constructor(formatter: Formatter, scale: number, scaleFont: Font, minimum: number, maximum: number, logScale: boolean, majorTickStepHint: number, foregroundColor: Color, showMinorTicks: boolean, showScale: boolean);
     get scaleLength(): number;
     /** Only available post-draw */
@@ -39,6 +49,7 @@ export declare class LinearScale {
      * getValuePosition to work.
      */
     setDimensions(x: number, y: number, length: number, horizontal: boolean): void;
+    private snapRange;
     getValuePosition(value: number): number;
     getMinMax(): Range;
     getPositionValue(absolutePosition: number): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamcs/opi",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "OPI Display Renderer",
   "author": "Yamcs Team <yamcs@spaceapplications.com>",
   "repository": {