fcs-core-viewer 0.2.0 → 0.2.2

package/README.md

@@ -0,0 +1,10 @@
+# fcs-viewer-api
+
+This package provides TypeScript declaration files for the Femsolve Cloud Services 3D viewer.
+
+## Installation
+
+To install the package, run the following command:
+```bash
+npm install fcs-core-viewer
+```

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiBaseComponent.d.ts

@@ -0,0 +1,6 @@
+/**
+ * BaseComponents cannot host any other components. They are the base building blocks.
+ * The 'FcsUiMainComponents' host them.
+ */
+export declare class FcsUiBaseComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiFunctionGroup.d.ts

@@ -0,0 +1,14 @@
+import { FcsUiBaseComponent } from "./FcsUiBaseComponent";
+import { FcsUiInputCollector } from "./FcsUiInputCollector";
+/**
+ * Function Groups serve to provide a User Interface that allows
+ * user to do following
+ */
+export declare class FcsUiFunctionGroup extends FcsUiBaseComponent {
+    private readonly _functionGroupId;
+    private readonly _title;
+    private _inputCollectors;
+    constructor(title: string);
+    activateFunctionGroup(): string;
+    addInputCollector(collector: FcsUiInputCollector): void;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiInputCollector.d.ts

@@ -0,0 +1,10 @@
+import { FcsUiBaseComponent } from "./FcsUiBaseComponent";
+export declare class FcsUiInputCollector extends FcsUiBaseComponent {
+    private readonly _guid;
+    /**
+     * We generate a unique identifier for this input type. This will be required when we
+     * associate certain input collector UI elements to inputs they have collected.
+     */
+    constructor();
+    getId(): string;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiPushButton.d.ts

@@ -0,0 +1,8 @@
+import { FcsUiBaseComponent } from "./FcsUiBaseComponent";
+export declare class FcsUiPushButton extends FcsUiBaseComponent {
+    private static _collectedIdentifiers;
+    private _actionIdentifier;
+    private _imageAssetIdentifier;
+    constructor(tooltipText: string, actionIdentifier: number, imageAssetId: number);
+    getActionIdentifier(): number;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiSlider.d.ts

@@ -0,0 +1,3 @@
+import { FcsUiBaseComponent } from "./FcsUiBaseComponent";
+export declare class FcsUiSlider extends FcsUiBaseComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiStatusBar.d.ts

@@ -0,0 +1,27 @@
+import { StatusBarPosition } from "../Settings/FcsUiPositions";
+import { FcsUiBaseComponent } from "./FcsUiBaseComponent";
+export declare class FcsUiStatusBar extends FcsUiBaseComponent {
+    /**
+     * This is what the status bar shows.
+     */
+    private _textBuffer;
+    /**
+     * The initial text of the status bar.
+     */
+    private _startText;
+    /**
+     * Position where the status bar is docked.
+     */
+    private readonly _statusBarPosition;
+    /**
+     * Constructor.
+     * @param statusBarPosition
+     * @param startText
+     */
+    constructor(statusBarPosition?: StatusBarPosition, startText?: string);
+    /**
+     * Whatever we set here is going to set the status bar text.
+     * @param statusText
+     */
+    setStatusText(statusText: string): void;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/BaseComponents/FcsUiTreeView.d.ts

@@ -0,0 +1,3 @@
+import { FcsUiBaseComponent } from "./FcsUiBaseComponent";
+export declare class FcsUiTreeView extends FcsUiBaseComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/CloudCAE.d.ts

@@ -0,0 +1,48 @@
+import { FcsUiDockPanel } from "./MainComponents/FcsUiDockPanel";
+import { FcsUiDockedQuickMenu } from "./MainComponents/FcsUiDockedQuickMenu";
+import { FcsUiStatusBar } from "./BaseComponents/FcsUiStatusBar";
+import { FcsUiTreeView } from "./BaseComponents/FcsUiTreeView";
+import { FcsUiQuickOptionsMenu } from "./MainComponents/FcsUiQuickOptionsMenu";
+/**
+ * Refer to layout available at https://viewer-dev.femsolve.com
+ * CAE = computer-aided engineering
+ */
+export declare class CloudCAE {
+    /**
+     * Wrapper for all constructed UI elements.
+     */
+    private _uiDef;
+    /**
+     * Local references of all components that the 'CloudCAE' product contains.
+     * We keep them here so we can bind the logic here.
+     */
+    readonly LeftMainPanel: FcsUiDockPanel;
+    readonly RightMainPanel: FcsUiDockPanel;
+    readonly TopMainQuickMenu: FcsUiDockedQuickMenu;
+    readonly TopRightCornerOptionsMenu: FcsUiQuickOptionsMenu;
+    readonly RightQuickMenu: FcsUiDockedQuickMenu;
+    readonly BottomStatusBar: FcsUiStatusBar;
+    TreeView: FcsUiTreeView;
+    /**
+     * The CloudCAE app when constructed DEFINES what the UI will look like.
+     */
+    constructor();
+    /**
+     * Here we only initialize the TreeView.
+     */
+    private _setupLeftMainPanel;
+    /**
+     * Here we setup a DockedQuickMenu at the top.
+     */
+    private _setupTopbarMenu;
+    /**
+     * Top right corner options menu
+     * @param opt
+     */
+    private _setupTopRightOptionsMenu;
+    /**
+     *
+     */
+    private _setupRightDockedQuickMenu;
+    private _setupRightMainPanel;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/CloudCAEDummyActions.d.ts

@@ -0,0 +1,10 @@
+export declare enum ActionIds {
+    clickTreeView = 0,
+    clickFindById = 1,
+    clickFindElement = 2,
+    clickFindByElementProps = 3,
+    clickSearchSettings = 4
+}
+export declare const ActionIdToAction: {
+    [key in ActionIds]?: Function;
+};

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/CloudCAEDummyAssets.d.ts

@@ -0,0 +1,10 @@
+export declare enum ImageAssets {
+    btnTreeView = 0,
+    btnFindById = 1,
+    btnFindElement = 2,
+    btnFindByElementProps = 3,
+    btnSearchSettings = 4
+}
+export declare const ImageAssetsToUrls: {
+    [key in ImageAssets]?: string;
+};

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/ExclusiveComponents/FcsUiAdvancedHelp.d.ts

@@ -0,0 +1,3 @@
+import { FcsUiExclusiveComponent } from "./FcsUiExclusiveComponent";
+export declare class FcsUiAdvancedHelp extends FcsUiExclusiveComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/ExclusiveComponents/FcsUiExclusiveComponent.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Refers to component that can have only a single instance open at any time of
+ * a given type, for example, pop-up dialogs, prompt dialogs and or tooltips.
+ */
+export declare class FcsUiExclusiveComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiContextMenu.d.ts

@@ -0,0 +1,3 @@
+import { FcsUiMainComponent } from "./FcsUiMainComponent";
+export declare class FcsUiContextMenu extends FcsUiMainComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiDockPanel.d.ts

@@ -0,0 +1,7 @@
+import { FcsUiBaseComponent } from "../BaseComponents/FcsUiBaseComponent";
+import { DockPosition } from "../Settings/FcsUiPositions";
+import { FcsUiMainComponent } from "./FcsUiMainComponent";
+export declare class FcsUiDockPanel extends FcsUiMainComponent {
+    constructor(panelPosition: DockPosition);
+    addBaseComponent(component: FcsUiBaseComponent): void;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiDockedQuickMenu.d.ts

@@ -0,0 +1,10 @@
+import { DockPosition } from "../Settings/FcsUiPositions";
+import { FcsUiMainComponent } from "./FcsUiMainComponent";
+export declare class FcsUiDockedQuickMenu extends FcsUiMainComponent {
+    private readonly _dockPosition;
+    constructor(dockPosition: DockPosition);
+    /**
+     * Adds a vertical splitter line.
+     */
+    addSplitter(): void;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiDropButton.d.ts

@@ -0,0 +1,5 @@
+import { FcsUiPushButton } from "../BaseComponents/FcsUiPushButton";
+import { FcsUiMainComponent } from "./FcsUiMainComponent";
+export declare class FcsUiDropButton extends FcsUiMainComponent {
+    addButton(position: number, button: FcsUiPushButton): void;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiHowerPanel.d.ts

@@ -0,0 +1,3 @@
+import { FcsUiMainComponent } from "./FcsUiMainComponent";
+export declare class FcsUiHowerPanel extends FcsUiMainComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiMainComponent.d.ts

@@ -0,0 +1,2 @@
+export declare class FcsUiMainComponent {
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/MainComponents/FcsUiQuickOptionsMenu.d.ts

@@ -0,0 +1,12 @@
+import { FcsUiMainComponent } from "./FcsUiMainComponent";
+import { QuickOptionsCorner } from "../Settings/FcsUiPositions";
+export declare class FcsUiQuickOptionsMenu extends FcsUiMainComponent {
+    /**
+     * Singleton instance => only one quick options menu is allowed.
+     */
+    private static _instance;
+    /**
+     * This is a singleton for
+     */
+    constructor(placedCorner: QuickOptionsCorner.TOP_RIGHT_CORNER);
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/Settings/FcsUiButtonStyle.d.ts

@@ -0,0 +1,22 @@
+export declare enum FcsUiButtonStyle {
+    /**
+     * No icon, instead there is some short text
+     */
+    WITH_CAPTION = 0,
+    /**
+     * No caption, instead of there is an icon.
+     */
+    WITH_ICON = 1,
+    /**
+     * Typically used to indicate buttons that when we click on them they expect a user action
+     */
+    INPUT_TYPE = 2,
+    /**
+     * Pop-up dialogs and hower panels may have them.
+     */
+    PROMPT = 3,
+    /**
+     * For context menus
+     */
+    QUICK_ACTION = 4
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/Settings/FcsUiPositions.d.ts

@@ -0,0 +1,20 @@
+export declare enum DockPosition {
+    LEFT = 0,
+    BOTTOM = 1,
+    RIGHT = 2,
+    TOP = 3
+}
+export declare enum StatusBarPosition {
+    BOTTOM = 0,
+    TOP = 1
+}
+export declare enum SpawnLocationReference {
+    TOP_LEFT_CORNER = 0,
+    TOP_RIGHT_CORNER = 1,
+    BOTTOM_RIGHT_CORNER = 2,
+    BOTTOM_LEFT_CORNER = 3
+}
+export declare enum QuickOptionsCorner {
+    TOP_LEFT_CORNER = 0,
+    TOP_RIGHT_CORNER = 1
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/Settings/FcsUiSizing.d.ts

@@ -0,0 +1,4 @@
+export declare class DialogSize {
+    width: number;
+    height: number;
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/Wrapper/FcsUiBinder.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Storage class for method bindings, and asset bindings.
+ */
+export declare class FcsUiBinder {
+    constructor();
+}

package/fcs-core-viewer@types/UserInterface/UiApi_deprecated/Wrapper/FcsUiDefinition.d.ts

@@ -0,0 +1,8 @@
+import { FcsUiStatusBar } from "../BaseComponents/FcsUiStatusBar";
+import { FcsUiMainComponent } from "../MainComponents/FcsUiMainComponent";
+export declare class FcsUiDefinition {
+    private _uiBinder;
+    constructor();
+    addStatusBar(component: FcsUiStatusBar): void;
+    addMainComponent(component: FcsUiMainComponent): void;
+}

package/package.json

@@ -1,42 +1,42 @@
-{
-    "name": "fcs-core-viewer",
-    "version": "0.2.0",
-    "description": "3D Viewer in the Cloud",
-    "author": {
-        "name": "Femsolve Kft."
-    },
-    "main": "webpack.config.js",
-    "files": [
-        "fcs-core-viewer@types"
-    ],
-    "scripts": {
-        "build:dev": "webpack --progress --stats-error-details --config webpack.dev.js",
-        "build": "webpack --progress --stats-error-details --config webpack.prod.js",
-        "server": "webpack serve --config webpack.server.js --mode development"
-    },
-    "license": "ISC",
-    "devDependencies": {
-        "@types/uuid": "^9.0.2",
-        "copy-webpack-plugin": "^11.0.0",
-        "css-loader": "^6.7.3",
-        "css-minimizer-webpack-plugin": "^5.0.0",
-        "dotenv-webpack": "^8.0.1",
-        "javascript-obfuscator": "^4.1.0",
-        "mini-css-extract-plugin": "^2.7.5",
-        "null-loader": "^4.0.1",
-        "style-loader": "^3.3.2",
-        "tailwindcss": "^3.4.1",
-        "ts-loader": "^9.4.2",
-        "typescript": "^4.9.5",
-        "webpack": "^5.89.0",
-        "webpack-cli": "^5.1.4",
-        "webpack-dev-server": "^4.15.1",
-        "webpack-obfuscator": "^3.5.1"
-    },
-    "dependencies": {
-        "axios": "^1.5.1",
-        "dom-to-image": "^2.6.0",
-        "socket.io-client": "^4.7.2",
-        "uuid": "^9.0.0"
-    }
+{
+    "name": "fcs-core-viewer",
+    "version": "0.2.2",
+    "description": "3D Viewer in the Cloud",
+    "author": {
+        "name": "Femsolve Kft."
+    },
+    "main": "webpack.config.js",
+    "files": [
+        "fcs-core-viewer@types"
+    ],
+    "scripts": {
+        "build:dev": "webpack --progress --stats-error-details --config webpack.dev.js",
+        "build": "webpack --progress --stats-error-details --config webpack.prod.js",
+        "server": "webpack serve --config webpack.server.js --mode development"
+    },
+    "license": "ISC",
+    "devDependencies": {
+        "@types/uuid": "^9.0.2",
+        "copy-webpack-plugin": "^11.0.0",
+        "css-loader": "^6.7.3",
+        "css-minimizer-webpack-plugin": "^5.0.0",
+        "dotenv-webpack": "^8.0.1",
+        "javascript-obfuscator": "^4.1.0",
+        "mini-css-extract-plugin": "^2.7.5",
+        "null-loader": "^4.0.1",
+        "style-loader": "^3.3.2",
+        "tailwindcss": "^3.4.1",
+        "ts-loader": "^9.4.2",
+        "typescript": "^4.9.5",
+        "webpack": "^5.89.0",
+        "webpack-cli": "^5.1.4",
+        "webpack-dev-server": "^4.15.1",
+        "webpack-obfuscator": "^3.5.1"
+    },
+    "dependencies": {
+        "axios": "^1.5.1",
+        "dom-to-image": "^2.6.0",
+        "socket.io-client": "^4.7.2",
+        "uuid": "^9.0.0"
+    }
 }