@pilotdev/pilot-web-2d 23.0.7-alpha.1

package/LICENCE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,5 @@
+# Installation
+> `npm install --save-dev @pilotdev/pilot-web-2d`
+
+# Summary
+This package contains type definitions for Ascon **PilotWeb2D** component (https://pilotcloud.ascon.net).

package/index.d.ts

@@ -0,0 +1,476 @@
+declare namespace PilotWeb2D {
+export class InitializerOptions {
+    libList?: string[];
+    language?: string;
+}
+class Global {
+    G: any;
+    RESOURCE_ROOT: string;
+    initializeResourceRoot(options: InitializerOptions): void;
+    getResourceUrl(resourceRelativePath: string): string;
+}
+export const global: Global;
+export {};
+export type StringMap = {
+    [key: string]: any;
+};
+export class Localization {
+    static initialize(options: any): Promise<void>;
+    static translate<T extends (string | StringMap) = string>(stringToTrans: string): T;
+    static setLanguage(language: string): Promise<void>;
+    static extendLocalization(locales: any): boolean;
+}
+export type InitializeSuccessCallback = () => void;
+export function coreInitializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
+export function coreShutdown(): void;
+export interface IWindowStyle {
+    width: string;
+    height: string;
+    left: string;
+    right: string;
+    top: string;
+}
+export interface IWindowStateOptions {
+    saveKey: string;
+    restoreWindowSize: boolean;
+}
+export class WindowStater {
+    get windowStylesState(): IWindowStyle;
+    get windowOptionsState(): IWindowStateOptions;
+    restore(): void;
+    saveWindowState(): void;
+}
+export class Resizer {
+    
+    constructor(resizableContainer: HTMLElement, containerToRestriction: HTMLElement, elementAnchor?: HTMLElement, windowStater?: WindowStater);
+    get windowState(): IWindowStyle | null;
+}
+export class Dragger {
+    
+    constructor(allowedDraggableElement: HTMLElement, draggableContainer: HTMLElement, containerToRestriction: HTMLElement, windowStater?: WindowStater);
+    get windowState(): IWindowStyle | null;
+}
+export namespace Viewer3DIcons {
+    const VIEWER_SETTINGS_ICON: string;
+    const VIEWER_MODEL_BROWSER_ICON: string;
+    const VIEWER_FULL_SCREEN_ICON: string;
+    const VIEWER_COLLAPSE_ICON: string;
+    const VIEWER_ELEMENT_PROPERTIES_ICON: string;
+    const VIEWER_ADD_CLIPPING_PLANE_ICON: string;
+    const VIEWER_CLIPPING_FLIP_ICON: string;
+    const VIEWER_DELETE_CLIPPING_PLANE_ICON: string;
+    const VIEWER_CLIPPING_CUBE_ICON: string;
+    const VIEWER_ADD_REMARK_ICON: string;
+    const VIEWER_MEASUREMENT_EDGE_ICON: string;
+    const VIEWER_MEASUREMENT_PLANE_ICON: string;
+    const VIEWER_MEASUREMENT_DIMENSION_ICON: string;
+}
+export namespace ViewerGeneralIcons {
+    const CLOSE: string;
+    const STRETCH_WINDOW: string;
+    const EXPAND_TREE: string;
+    const COLLAPSE_TREE: string;
+    const ARROW_DROP_DOWN: string;
+    const ARROW_DROP_RIGHT: string;
+    const CIRCLE_ICON: string;
+    const SHOW: string;
+    const HIDE: string;
+    const TRASH: string;
+    const ARROW_DR: string;
+}
+export namespace Viewer2DIcons {
+    const REMARK_CIRCLE_ICON: string;
+    const ZOOM_IN: string;
+    const ZOOM_OUT: string;
+}
+export interface ISettings {
+    changeSetting<T>(name: string, value: T, notify?: boolean, providedData?: any): void;
+    getSettingValue<T>(name: string): T;
+}
+export enum BaseSettingsNames {
+    TOOLBAR = "toolbar",
+    TOOLBAR_POSITION = "toolbarPosition",
+    TOOLBAR_CONTENT_ALIGNMENT = "toolbarContent",
+    THEME = "theme"
+}
+export class SettingChangedEvent extends Event {
+    name: string;
+    oldValue: any;
+    newValue: any;
+    providedData: any;
+}
+export class LoadingSpinner {
+    addToDOM(container: HTMLElement): void;
+    removeFromDOM(container: HTMLElement): void;
+}
+export class CoreEventTypes {
+    static VIEWER_RESIZE_EVENT: string;
+    static VIEWER_MOUSE_DOWN_EVENT: string;
+    static VIEWER_MOUSE_MOVE_EVENT: string;
+    static VIEWER_MOUSE_UP_EVENT: string;
+    static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
+    static SETTING_CHANGED_EVENT: string;
+    static SETTING_RESET_EVENT: string;
+    static SETTING_LANGUAGE_CHANGED_EVENT: string;
+    static SETTING_THEME_CHANGED_EVENT: string;
+}
+export interface IControl {
+    container: HTMLElement;
+    getId(): string;
+    setToolTip(tooltipText: string): void;
+    setText(text: string): void;
+}
+export class Control implements IControl {
+    container: HTMLElement;
+    
+    constructor(id: string);
+    addClass(cssClass: string): void;
+    removeClass(cssClass: string): void;
+    getId(): string;
+    setToolTip(tooltipText: string): void;
+    setText(text: string): void;
+}
+export enum ToolbarPosition {
+    TOP_FIXED = "ascn-toolbar-position-fixed-top",
+    TOP_FLUENT = "ascn-toolbar-position-top",
+    BOTTOM_FIXED = "ascn-toolbar-position-fixed-bottom",
+    BOTTOM_FLUENT = "ascn-toolbar-position-bottom"
+}
+export enum ToolbarContentAlignment {
+    CENTER = "ascn-toolbar-content-center",
+    START = "ascn-toolbar-content-start",
+    END = "ascn-toolbar-content-end"
+}
+export interface ToolbarStyle {
+    [BaseSettingsNames.TOOLBAR_POSITION]?: ToolbarPosition;
+    [BaseSettingsNames.TOOLBAR_CONTENT_ALIGNMENT]?: ToolbarContentAlignment;
+}
+export const defaultToolbarAppearance: ToolbarStyle;
+export interface IMenu {
+    controls: IControl[];
+    addControl(control: IControl, index?: number): void;
+    removeControl(index: number): void;
+}
+interface IToolbarButton {
+    button: IControl;
+    index: number;
+}
+export class Toolbar extends Control implements IMenu {
+    readonly controls: IControl[];
+    addControl(control: IControl, index?: number): void;
+    removeControl(index: number): void;
+    getControls(): IToolbarButton[];
+    changeToolbarPosition(direction: ToolbarPosition): void;
+    changeToolbarContentAlignment(content: ToolbarContentAlignment): void;
+}
+export {};
+export class ExtensionBase {
+    protected _viewer: ViewerBase;
+    protected _options: object;
+    
+    constructor(viewer3D: ViewerBase, options?: object);
+    load(): boolean | Promise<boolean>;
+    unload(): boolean;
+    activate(): boolean;
+    deactivate(): boolean;
+    /**
+    * Gets the name of the extension.
+    * @returns {string} Returns the name of the extension.
+      */
+    getName(): string;
+    onMouseDown(event: MouseEvent): void;
+    onMouseMove(event: MouseEvent): void;
+    onMouseUp(event: MouseEvent): void;
+    onMouseLongTouch(event: MouseEvent): void;
+    onToolbarCreated(toolbar: Toolbar): void;
+    protected bindDomEvents(): void;
+}
+export class ExtensionManager {
+    registerExtensionType(extensionId: string, extension: typeof ExtensionBase): boolean;
+    unregisterExtensionType(extensionId: string): boolean;
+    getExtensionType(extensionId: string): typeof ExtensionBase;
+}
+export const theExtensionManager: ExtensionManager;
+export class ExtensionLoader {
+    /**
+     * Loads the extension with the given id and options.
+     *
+     * @param {string} extensionId - The string id of the extension.
+     * @param {object} options - An optional dictionary of options.
+     *
+     * @returns {Promise<ExtensionBase>} - Resolves with the extension requested.
+     */
+    loadExtension(extensionId: string, options?: object): Promise<ExtensionBase>;
+    /**
+     * Unloads the extension with the given id.
+     *
+     * @param {string} extensionId - The string id of the extension.
+     * @returns {Promise<boolean>} - True if the extension was successfully unloaded.
+     */
+    unloadExtension(extensionId: string): Promise<boolean>;
+    /**
+     * Returns all loaded extensions.
+     * @returns {?string[]} - Ids of loaded extensions.
+     */
+    getExtensions(): string[];
+    /**
+     * Returns the loaded extension.
+     * @param {string} extensionId - The string id of the extension.
+     * @returns {?ExtensionBase} - Extension.
+     */
+    getExtension(extensionId: string): ExtensionBase;
+}
+export interface IEventsDispatcher {
+    addEventListener(event: string, listener: EventListener, options?: object): void;
+    removeEventListener(event: string, listener: EventListener): void;
+    hasEventListener(event: string, listener: EventListener): boolean;
+    dispatchEvent(event: string | Event): void;
+    dispatchEventAsync(event: string | Event): void;
+    clearListeners(): void;
+}
+export enum SettingsTheme {
+    LIGHT_THEME = "ascn-light",
+    DARK_THEME = "ascn-dark"
+}
+export const defaultThemeAppearance: string;
+export type ViewerSettings = Record<string, any>;
+export class ViewerConfiguration {
+    settingsPrefix: string;
+    appearance: ViewerSettings;
+    createConfiguration(configuration: ViewerSettings, origin: ViewerSettings): void;
+    mergeConfigurationAndSettings(configuration: ViewerSettings, settings: ISettings): void;
+    changeTheme(newTheme: string): void;
+}
+export type ErrorCallback = (message: string) => void;
+export type SuccessCallback = (modelId: any) => void;
+export enum DocumentType {
+    UNKNOWN = 0,
+    DOCUMENT_2D = 1,
+    DOCUMENT_3D = 2
+}
+export const defaultBaseSettings: ViewerConfiguration;
+export abstract class ViewerBase {
+    protected _clientContainer: HTMLElement;
+    protected _loadingSpinner: LoadingSpinner;
+    protected _documentType: DocumentType;
+    protected _configuration: ViewerConfiguration;
+    readonly container: HTMLElement;
+    readonly extensionsLoader: ExtensionLoader;
+    abstract settings: ISettings;
+    abstract events: IEventsDispatcher;
+    get rootContainer(): HTMLElement;
+    getConfiguration(): ViewerConfiguration;
+    /**
+     *
+     * @returns
+     */
+    start(): Promise<number>;
+    /**
+     *
+     */
+    finish(): void;
+    onPostExtensionLoad(extension: ExtensionBase): void;
+    protected loadExtensions(): void;
+    protected setThemeFromSettings(): void;
+}
+export class EventsDispatcherCore implements IEventsDispatcher {
+    dispatchEventAsync(event: string | Event): void;
+    hasEventListener(type: string, listener: EventListener): boolean;
+    dispatchEvent(event: string | Event): void;
+    addEventListener(type: string, listener: EventListener, options?: object): void;
+    removeEventListener(type: string, listener: EventListener): void;
+    removeEvent(type: string): void;
+    clearListeners(): void;
+}
+export namespace ControlState {
+    enum State {
+        ACTIVE = 0,
+        INACTIVE = 1,
+        DISABLED = 2
+    }
+}
+export class Button extends Control {
+    
+    constructor(id: string);
+    setIsChecked(value: boolean): void;
+    setState(state: ControlState.State): boolean;
+    setText(text: string): void;
+    getState(): ControlState.State;
+    setIcon(iconClassName: string): void;
+    setFromSvgTemlate(template: string): void;
+    /**
+     * Override this method to be notified when the user clicks on the button.
+     * @param {MouseEvent} event
+     */
+    onClick: (event: MouseEvent) => void;
+    /**
+     * Override this method to be notified when the mouse enters the button.
+     * @param {MouseEvent} event
+     */
+    onMouseOver: (event: MouseEvent) => void;
+    /**
+     * Override this method to be notified when the mouse leaves the button.
+     * @param {MouseEvent} event
+     */
+    onMouseOut: (event: MouseEvent) => void;
+}
+export namespace Button {
+    enum Event {
+        STATE_CHANGED = "Button.StateChanged",
+        CLICK = "click"
+    }
+}
+export class SubMenu implements IMenu {
+    readonly controls: IControl[];
+    set selectedIndex(value: number);
+    get selectedIndex(): number;
+    addControl(control: IControl, index?: number): void;
+    removeControl(index?: number): void;
+    clearList(): void;
+    changeControl(item: IControl, index: number): void;
+    getControlsCount(): number;
+}
+export class ComboButton extends Control {
+    
+    constructor(id: string, selectedIndex?: number);
+    get subMenu(): SubMenu;
+    /**
+     * Override this method to be notified when the user clicks on the button.
+     * @param {MouseEvent} event
+     */
+    onClick: (event: PointerEvent) => void;
+    onOpen: () => void;
+    onClose: () => void;
+    setState(state: ControlState.State): boolean;
+    setText(text: string): void;
+    setFromSvgTemlate(template: string): void;
+}
+export class ViewerToolbar extends Toolbar {
+}
+interface ElementClass {
+    panelClassName?: string;
+    contentClassName?: string;
+    headerClassName?: string;
+}
+export class Dialog extends Control {
+    responseDialog: (state?: boolean) => void;
+    
+    constructor(id: string, panelToAttach: HTMLElement);
+    get dialog(): HTMLElement;
+    get dialogContent(): HTMLElement;
+    get resizable(): boolean;
+    setDialogContent(value: HTMLElement): Dialog;
+    setHeader(value: HTMLElement): Dialog;
+    setCaption(value: string): Dialog;
+    setIcon(iconClassName: string): Dialog;
+    setFooter(value: HTMLElement): Dialog;
+    setDialogElementClassNames(value: ElementClass): Dialog;
+    setResizable(value: boolean): Dialog;
+    setWindowOptions(value: IWindowStateOptions): Dialog;
+    setDraggable(value: boolean): Dialog;
+    openDialog(): HTMLElement;
+    destroyDialog(): void;
+    isDialogShown(): boolean;
+    subscribe(fn: (state: boolean) => void): void;
+}
+export {};
+export interface ISettingsStorage {
+    clear(): void;
+    getItem<T>(key: string): T | null;
+    removeItem(key: string): void;
+    setItem<T>(key: string, value: T): void;
+    getKeys(): string[];
+}
+export class SettingsStorageFactory {
+    getSettingsStorage(): ISettingsStorage;
+}
+export class LocalSettingsStorage implements ISettingsStorage {
+    clear(): void;
+    getItem<T>(key: string): T | null;
+    removeItem(key: string): void;
+    setItem<T>(key: string, value: T): void;
+    getKeys(): string[];
+}
+export class InMemorySettingsStorage implements ISettingsStorage {
+    clear(): void;
+    getItem<T>(key: string): T | null;
+    removeItem(key: string): void;
+    setItem<T>(key: string, value: T): void;
+    getKeys(): string[];
+}
+export abstract class SettingsBase implements ISettings {
+    protected _eventDispatcher: IEventsDispatcher;
+    protected _storage: ISettingsStorage;
+    changeSetting<T>(name: string, value: T, notify?: boolean, providedData?: any): void;
+    getSettingValue<T>(name: string): T;
+    protected abstract getKeyWithPrefix(key: string): string;
+}
+export interface IAnnotationLayer {
+    get pageDiv(): HTMLDivElement;
+    get div(): HTMLDivElement | null;
+    addOverlay(overlay: HTMLElement): void;
+    removeOverlay(overlay: HTMLElement): void;
+    getOverlays(): HTMLElement[];
+}
+export interface IPageUpdateParams {
+    scale?: number;
+    drawingDelay?: number;
+}
+export interface IDocumentPage {
+    get div(): HTMLDivElement;
+    get canvas(): HTMLCanvasElement | SVGSVGElement;
+    get pageNumber(): number;
+    get viewport(): DOMRect;
+    get annotationLayer(): IAnnotationLayer | null;
+    get height(): number;
+    get width(): number;
+    get scale(): number;
+    update(params?: IPageUpdateParams): void;
+    dispose(): any;
+}
+export interface IDocument {
+    loadDocumentAsync(arrayBuffer: ArrayBuffer): Promise<void>;
+    increaseScale(steps?: number, scaleFactor?: number): void;
+    decreaseScale(steps?: number, scaleFactor?: number): void;
+    fit(): void;
+    getPageAsync(pageNumber: number): Promise<IDocumentPage>;
+    getPageByTarget(element: HTMLElement): IDocumentPage | undefined;
+    dispose(): void;
+}
+export const ZOOM_IN_SCALE_FACTOR = 1.15;
+export const ZOOM_OUT_SCALE_FACTOR = 0.85;
+export const ZOOM_MAX_SCALE = 10;
+export const ZOOM_MIN_SCALE = 4;
+export class Viewer2DConfiguration extends ViewerConfiguration {
+    
+    constructor(appearance?: ViewerSettings);
+}
+export let ViewerInstance: Viewer2D;
+export class Viewer2D extends ViewerBase {
+    readonly settings: Readonly<ISettings>;
+    readonly events: Readonly<IEventsDispatcher>;
+    get document(): IDocument;
+    loadDocument(buffer: ArrayBuffer, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+    unloadDocument(): void;
+    start(): Promise<number>;
+    finish(): void;
+    protected zoomIn(event: MouseEvent): void;
+    protected zoomOut(event: MouseEvent): void;
+}
+export class GuiViewer2D extends Viewer2D {
+    loadDocument(buffer: ArrayBuffer, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+    getToolbar(): ViewerToolbar;
+    onPostExtensionLoad(extension: ExtensionBase): void;
+    protected getToolbarHeight(): number;
+}
+export class Extension extends ExtensionBase {
+    protected _viewer: Viewer2D;
+}
+export class Point2 {
+    x: number;
+    y: number;
+    
+    constructor(x: number, y: number);
+}
+
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@pilotdev/pilot-web-2d",
+  "version": "23.0.7-alpha.1",
+  "description": "TypeScript definitions for ASCON PilotWeb2D component",
+  "main": "",
+  "types": "index.d.ts",
+  "scripts": {},
+  "author": "JSC Ascon",
+  "license": "MIT",
+  "typeScriptVersion": "4.9.4",
+  "keywords": [
+    "pilotdev",
+    "PilotWeb3D",
+    "PilotWeb2D",
+    "Pilot-Cloud"
+  ]
+}