fcs-core-viewer 0.9.2 → 0.10.1

package/fcs-core-viewer@types/Api.d.ts

@@ -8,3 +8,4 @@ export * from './CloudViewer/Settings/Index';
 export * from './Model/Index';
 export * from './CloudViewer/Index';
 export * from './Common/Index';
+export * from './UserInterface/UIComponents/Index';

package/fcs-core-viewer@types/BackendEvents/BackendEvents.d.ts

@@ -21,12 +21,6 @@ interface BackendInstructions {
      * Task callback arguments
      */
     callback_guid_id?: string;
-    /**
-     * Optional addin arguments
-     */
-    addin_command?: string;
-    addin?: string;
-    on_finished_arguments?: {};
 }
 /**
  * All events that were triggered by the backend.
@@ -94,12 +88,12 @@ export declare class BackendEvents implements IBackendEvents {
      * Contains guid to backend service mappings.
      */
     attachedServices: {
-        [key: string]: CloudViewer.BackendService;
+        [key: string]: CloudViewer.PluginService;
     };
     /**
      * Contains all approved guids
      */
-    registeredAddinGuids: string[];
+    registeredPluginNames: string[];
     /**
      * Callback function GUIDs
      */
@@ -122,7 +116,7 @@ export declare class BackendEvents implements IBackendEvents {
      * @param service
      * @param serviceMethod
      */
-    attachService(service: CloudViewer.BackendService): void;
+    attachService(service: CloudViewer.PluginService): void;
     /**
      * We pass in a function that will be called when the backend task finishes.
      * We save this method in a dictionary where it will receive a GUID.

package/fcs-core-viewer@types/CloudViewer/FcsViewer.d.ts

@@ -31,7 +31,7 @@ export declare namespace CloudViewer {
         private _canvas;
         private _initSettings;
         private _viewerWrapper;
-        private _registeredAddinApplications;
+        private _registeredPlugins;
         private _backendManager;
         private _activeSelectionFilter;
         private _onSelectionEvent;
@@ -42,22 +42,6 @@ export declare namespace CloudViewer {
          * Constructor to instantiate viewer.
          */
         constructor(container: HTMLDivElement, initSettings?: ViewerSettings, licenseToken?: string, disallowSocketCallbacks?: boolean);
-        /**
-         * Constructs a top level item with geometric definition.
-         * @param itemId Unique ID of the item.
-         * @param itemName Name of the item.
-         * @param stlFileUrl Public download URL for STL file.
-         * @param t2gFileUrl Public download URL for T2G file.
-         */
-        /**
-         * Places an item with geometric definition under a specified already existing item.
-         * @param itemId Unique ID of the item.
-         * @param parentId Unique ID of the item's parent.
-         * @param itemName Name of the item.
-         * @param stlFileUrl Public download URL for STL file.
-         * @param t2gFileUrl Public download URL for T2G file.
-         */
-        addToDocumentUnder(itemId: number, parentId: number, itemName: string, stlFileUrl: string, t2gFileUrl: string, isCADModel: boolean): Promise<void>;
         /**
          * Generates a unique id in the viewer
          */
@@ -112,17 +96,21 @@ export declare namespace CloudViewer {
          * Method for forwarding commands with args.
          * @param service
          */
-        forwardCommandForService(service: BackendService, commandName: string, commandArgs: any): Promise<void>;
+        forwardCommandForService(service: PluginService, commandName: string, commandArgs: {
+            [key: string]: any;
+        }): Promise<Response>;
         /**
          * Method for forwarding commands with args.
          * @param service
          */
-        forwardCommandForServiceBlob(service: BackendService, commandName: string, commandFile: File, commandArgs: any): Promise<void>;
+        forwardCommandForServiceBlob(service: PluginService, commandName: string, commandFile: File, commandArgs: any): Promise<Response>;
         /**
-         * A custom application that requires a specific backend implementation.
-         * @param backendService
+         * Loads a specific module of a plugin. Every single service that is
+         * required to be used needs to be manually specified here.
+         * @param pluginName Name of the backend service module we
+         * @param pluginClassName
          */
-        registerApplication(backendService: BackendService): Promise<void>;
+        loadPlugin(pluginService: PluginService): Promise<void>;
         /**
          * Use this method to startup the viewer. If no backend service is registered.
          */
@@ -273,9 +261,6 @@ export declare namespace CloudViewer {
          * @param temoraryGroup Temporary group that will store the annotation
          */
         addAnnotation(annotation: AnnotationEntities.AnnotationElement, temoraryGroup: TemporaryEntities.TemporaryGroup): void;
-        /**
-         * Functions required for manipulating the model tree
-         */
         /**
          * The returned JSON contains detailed hierarchical informations
          * how the model is setup.
@@ -288,7 +273,7 @@ export declare namespace CloudViewer {
          */
         getComponents(): {};
         /**
-         * Kiszamolja a modell komponenseit alkoto face-ek midPointjait
+         * Available face UIDs visible are returned.
          * @returns List of unique face IDs.
          */
         getFaceUIDs(): any[];
@@ -327,7 +312,7 @@ export declare namespace CloudViewer {
      * This interface serves to enforce the format of creating a frontend checkpoints
      * that requires the backend server.
      */
-    abstract class BackendService {
+    abstract class PluginService {
         /**
          * Viewer instance associated with backend service.
          */
@@ -340,37 +325,30 @@ export declare namespace CloudViewer {
         /**
          * Forward the command to the backend service.
          * @param commandName
-         * @param args Custom arguments the backend service expects
+         * @param commandArgs Custom arguments the backend service expects
          */
-        protected forwardCommand(commandName: string, args: any): void;
+        protected forwardCommand(commandName: string, commandArgs: any): Promise<Response>;
         /**
          * Forward the command to the backend service with input file.
          * @param commandName
          * @param blob
-         * @param args
-         */
-        protected forwardCommandWithBlob(commandName: string, blob: File, args: any): void;
-        /**
-         * Returns array of functions that are called
-         * when backend service finishes.
+         * @param commandArgs
          */
-        abstract getOnFinishedEvents(): {
-            [key: string]: Function;
-        };
+        protected forwardCommandWithBlob(commandName: string, blob: File, commandArgs: any): Promise<Response>;
         /**
-         * Getter for plugin GUID.
-         * The plugin Guid represents the entry point file's name.
-         * For example, if plugin guid is '1234-5678', then on the backend
+         * Getter for plugin name.
+         * The plugin name represents the entry point file's name.
+         * For example, if plugin name is '1234-5678', then on the backend
          * server a local copy of '1234-5678' folder will be created with a
          * 1234-5678.py entry point file.
          */
-        abstract getServiceGuid(): string;
+        abstract getPluginName(): string;
         /**
          * Getter for plugin name.
-         * Based on the `getServiceGuid` example above, the entry point file that has
-         * the 'BackendService' is located. Inside this file the `BackendService's`
+         * Based on the `getPluginName` example above, the entry point file that has
+         * the 'PluginService' is located. Inside this file the `PluginService's`
          * implementation class has this name.
          */
-        abstract getServiceClassName(): string;
+        abstract getPluginClassName(): string;
     }
 }

package/fcs-core-viewer@types/FrontendEvents/SidebarEvents.d.ts

@@ -5,8 +5,8 @@ export declare class SidebarEvents {
     sceneWrapper: SceneWrapper;
     readonly menuSections: any[];
     readonly topbarSections_L1: any[];
-    readonly a_geom: HTMLElement;
-    readonly a_1D: HTMLElement;
+    readonly a_CAD: HTMLElement;
+    readonly a_CAE: HTMLElement;
     readonly viewerCADToolbox: ViewerCADToolbox;
     readonly viewerCAEToolbox: ViewerCAEToolbox;
     readonly a_dev: HTMLElement;
@@ -16,11 +16,13 @@ export declare class SidebarEvents {
     readonly a_node: HTMLElement;
     readonly icon_options: HTMLElement;
     readonly section_options: HTMLElement;
+    readonly file_dialog: HTMLElement;
     constructor(sceneWrapper: SceneWrapper);
     /**
      * Registers event listeners.
      */
     private _registerListeners;
-    private activateButton;
-    private deactivateButton;
+    private closeSectionOption;
+    private activateElement;
+    private deactivateElement;
 }

package/fcs-core-viewer@types/UserInterface/UIComponents/Index.d.ts

@@ -0,0 +1,5 @@
+import * as ToolboxBuilder from './MainMenu/Toolboxes/ToolboxBuilder';
+declare const ViewerUiBuilder: {
+    ToolboxBuilder: typeof ToolboxBuilder.ToolboxBuilder;
+};
+export { ViewerUiBuilder };

package/fcs-core-viewer@types/UserInterface/UIComponents/MainMenu/Toolboxes/BaseToolbox.d.ts

@@ -0,0 +1,3 @@
+export declare class Toolbox {
+    addMethodGroup(groupName: string): any;
+}

package/fcs-core-viewer@types/UserInterface/UIComponents/MainMenu/Toolboxes/CADToolbox.d.ts

@@ -1,4 +1,5 @@
-export declare class ViewerCADToolbox {
+import { Toolbox } from "./BaseToolbox";
+export declare class ViewerCADToolbox extends Toolbox {
     operationUIs: any;
     private id;
     private element;

package/fcs-core-viewer@types/UserInterface/UIComponents/MainMenu/Toolboxes/CAEToolbox.d.ts

@@ -1,4 +1,5 @@
-export declare class ViewerCAEToolbox {
+import { Toolbox } from "./BaseToolbox";
+export declare class ViewerCAEToolbox extends Toolbox {
     operationUIs: any;
     private id;
     private element;

package/fcs-core-viewer@types/UserInterface/UIComponents/MainMenu/Toolboxes/ToolboxBuilder.d.ts

@@ -0,0 +1,4 @@
+import { Toolbox } from "./BaseToolbox";
+export declare namespace ToolboxBuilder {
+    function addToolbox(toolboxName: string): Toolbox;
+}

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

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fcs-core-viewer",
-    "version": "0.9.2",
+    "version": "0.10.1",
     "description": "3D Viewer in the Cloud",
     "author": {
         "name": "Femsolve Kft."