@pilotdev/pilot-web-sdk 26.9.0 → 26.10.0

package/.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "extends": "../../.eslintrc.json",
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "lib",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "lib",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "rules": {}
+    }
+  ]
+}

package/extensions.config.schema.json

@@ -1,172 +1,133 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "@pilotdev/pilot-web-sdk/extensions.config.schema.json",
-  "title": "Pilot Web-Extensions Config",
-  "description": "JSON Schema for `extensions.config.json` file",
-  "type": "object",
-  "properties": {
-    "$schema": {
-      "type": "string",
-      "description": "The schema to verify this document against."
-    },
-    "manifestVersion": {
-      "type": "number",
-      "description": "An integer that specifies the version of the manifest file format that your extension uses.",
-      "default": 1
-    },
-    "author": {
-      "type": "string",
-      "description": "Specifies author who created the extension."
-    },
-    "license": {
-      "type": "string",
-      "description": "The license under which the extension is distributed."
-    },
-    "title": {
-      "type": "string",
-      "description": "A human-readable title for the extension."
-    },
-    "description": {
-      "type": "string",
-      "description": "A detailed description of the extension's purpose and functionality."
-    },
-    "version": {
-      "type": "string",
-      "description": "A string that identifies the extension's version number.",
-      "default": "1.0.0"
-    },
-    "extension": {
-      "type": "object",
-      "description": "Configuration for the Pilot Web extension",
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "The name of the extension."
-        },
-        "description": {
-          "type": "string",
-          "description": "Short description of the extension's purpose and functionality."
-        },
-        "entry": {
-          "type": "string",
-          "description": "Path to the JavaScript entry point, relative to the `frontend` folder."
-        },
-        "modules": {
-          "type": "array",
-          "description": "An array of extension modules that are part of this extension.",
-          "items": {
-            "$ref": "#/definitions/extensionModule"
-          },
-          "minItems": 1
-        }
-      },
-      "required": [
-        "name",
-        "entry",
-        "modules"
-      ]
-    },
-    "pilotWeb2D": {
-      "type": "array",
-      "description": "An array of extension modules for PilotWeb2D component of Pilot-ComponentKit",
-      "items": {
-        "$ref": "#/definitions/componentKitModule"
-      },
-      "minItems": 1
-    },
-    "pilotWeb3D": {
-      "type": "array",
-      "description": "An array of extension modules for PilotWeb3D component of Pilot-ComponentKit",
-      "items": {
-        "$ref": "#/definitions/componentKitModule"
-      },
-      "minItems": 1
-    }
-  },
-  "required": [
-    "manifestVersion",
-    "title",
-    "version"
-  ],
-  "anyOf": [
-    {
-      "required": [
-        "extension"
-      ]
-    },
-    {
-      "required": [
-        "pilotWeb2D"
-      ]
-    },
-    {
-      "required": [
-        "pilotWeb3D"
-      ]
-    }
-  ],
-  "definitions": {
-    "extensionModule": {
-      "type": "object",
-      "properties": {
-        "ngModuleName": {
-          "type": "string",
-          "description": "Name of exported class"
-        },
-        "exposedInterface": {
-          "type": "string",
-          "description": "The interface implemented from @pilotdev/pilot-web-sdk. Must match the `exposes` key in the Module Federation config",
-          "enum": [
-            "ISettingsFeature",
-            "IDataPlugin",
-            "ICryptoProvider",
-            "IToolbar<ObjectsViewContext>",
-            "IToolbar<DocumentAnnotationsListContext>",
-            "IObjectCardHandler",
-            "IOpenspaceView<ObjectsViewContext>",
-            "IOpenspaceView<BimElementPanelContext>",
-            "IOpenspaceView<BimRightPanelContext>",
-            "IOpenspaceView<PageContext>",
-            "IOpenspaceView<SettingsFeatureContext>",
-            "IOpenspaceView<DialogContext>",
-            "IPageNavigation",
-            "ITabs<ObjectsViewContext>",
-            "ITabs<BimElementPanelContext>",
-            "ITabs<BimRightPanelContext>",
-            "IMenu<ObjectsViewContext>",
-            "IMenu<DocumentAnnotationsListContext>"
-          ]
-        }
-      },
-      "required": [
-        "ngModuleName",
-        "exposedInterface"
-      ]
-    },
-    "componentKitModule": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Name of exported class"
-        },
-        "description": {
-          "type": "string",
-          "description": "Short description of the Pilot-ComponentKit extension module's purpose and functionality."
-        },
-        "entry": {
-          "type": "string",
-          "description": "Path to the JavaScript entry point, relative to the `frontend` folder."
-        },
-        "cssEntry": {
-          "type": "string",
-          "description": "Path to the CSS entry point, relative to the `frontend` folder."
-        }
-      },
-      "required": [
-        "name",
-        "entry"
-      ]
-    }
-  }
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "@pilotdev/pilot-web-sdk/extensions.config.schema.json",
+  "title": "Pilot Web-Extensions Config",
+  "description": "JSON Schema for `extensions.config.json` file",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "The schema to verify this document against."
+    },
+    "manifestVersion": {
+      "type": "number",
+      "description": "An integer that specifies the version of the manifest file format that your extension uses.",
+      "default": 1
+    },
+    "author": {
+      "type": "string",
+      "description": "Specifies author who created the extension."
+    },
+    "license": {
+      "type": "string",
+      "description": "The license under which the extension is distributed."
+    },
+    "title": {
+      "type": "string",
+      "description": "A human-readable title for the extension."
+    },
+    "description": {
+      "type": "string",
+      "description": "A detailed description of the extension's purpose and functionality."
+    },
+    "version": {
+      "type": "string",
+      "description": "A string that identifies the extension's version number.",
+      "default": "1.0.0"
+    },
+    "extension": {
+      "type": "object",
+      "description": "Configuration for the Pilot Web extension",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the extension."
+        },
+        "description": {
+          "type": "string",
+          "description": "Short description of the extension's purpose and functionality."
+        },
+        "entry": {
+          "type": "string",
+          "description": "Path to the JavaScript entry point, relative to the `frontend` folder."
+        },
+        "modules": {
+          "type": "array",
+          "description": "An array of extension modules that are part of this extension.",
+          "items": {
+            "$ref": "#/definitions/extensionModule"
+          },
+          "minItems": 1
+        }
+      },
+      "required": ["name", "entry", "modules"]
+    },
+    "pilotWeb2D": {
+      "type": "array",
+      "description": "An array of extension modules for PilotWeb2D component of Pilot-ComponentKit",
+      "items": {
+        "$ref": "#/definitions/componentKitModule"
+      },
+      "minItems": 1
+    },
+    "pilotWeb3D": {
+      "type": "array",
+      "description": "An array of extension modules for PilotWeb3D component of Pilot-ComponentKit",
+      "items": {
+        "$ref": "#/definitions/componentKitModule"
+      },
+      "minItems": 1
+    }
+  },
+  "required": ["manifestVersion", "title", "version"],
+  "anyOf": [
+    {
+      "required": ["extension"]
+    },
+    {
+      "required": ["pilotWeb2D"]
+    },
+    {
+      "required": ["pilotWeb3D"]
+    }
+  ],
+  "definitions": {
+    "extensionModule": {
+      "type": "object",
+      "properties": {
+        "ngModuleName": {
+          "type": "string",
+          "description": "Name of exported class"
+        },
+        "exposedInterface": {
+          "type": "string",
+          "description": "The interface implemented from @pilotdev/pilot-web-sdk. Must match the `exposes` key in the Module Federation config",
+          "enum": [""]
+        }
+      },
+      "required": ["ngModuleName", "exposedInterface"]
+    },
+    "componentKitModule": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of exported class"
+        },
+        "description": {
+          "type": "string",
+          "description": "Short description of the Pilot-ComponentKit extension module's purpose and functionality."
+        },
+        "entry": {
+          "type": "string",
+          "description": "Path to the JavaScript entry point, relative to the `frontend` folder."
+        },
+        "cssEntry": {
+          "type": "string",
+          "description": "Path to the CSS entry point, relative to the `frontend` folder."
+        }
+      },
+      "required": ["name", "entry"]
+    }
+  }
 }

package/ng-package.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/pilot-web-sdk",
+  "lib": {
+    "entryFile": "src/public-api.ts"
+  },
+  "assets": [
+    "extensions.config.schema.json"
+  ]
+}

package/package.json

@@ -1,27 +1,14 @@
 {
   "name": "@pilotdev/pilot-web-sdk",
-  "version": "26.9.0",
+  "version": "26.10.0",
   "peerDependencies": {
     "@angular/common": "17.3.12",
     "@angular/core": "17.3.12",
-    "@pilotdev/pilot-web-3d": "25.8.4-alpha",
+    "@pilotdev/pilot-web-3d": "26.8.0",
     "rxjs": "7.8.1"
   },
   "dependencies": {
     "tslib": "2.3.0"
   },
-  "sideEffects": false,
-  "module": "fesm2022/pilotdev-pilot-web-sdk.mjs",
-  "typings": "index.d.ts",
-  "exports": {
-    "./package.json": {
-      "default": "./package.json"
-    },
-    ".": {
-      "types": "./index.d.ts",
-      "esm2022": "./esm2022/pilotdev-pilot-web-sdk.mjs",
-      "esm": "./esm2022/pilotdev-pilot-web-sdk.mjs",
-      "default": "./fesm2022/pilotdev-pilot-web-sdk.mjs"
-    }
-  }
-}
+  "sideEffects": false
+}

package/src/lib/base/disposable.ts

@@ -0,0 +1,14 @@
+export abstract class IDisposable {
+  constructor() {
+    if (this.constructor == IDisposable) {
+      throw new Error("Abstract classes can't be instantiated.");
+    }
+  }
+
+  /**
+   * The method is called just before class is disposed
+   */
+  dispose() {
+    throw new Error("Method 'dispose()' must be implemented.");
+  }
+}

package/{lib/base/index.d.ts → src/lib/base/index.ts}

@@ -1,2 +1,2 @@
-export * from './disposable';
-export * from './initializable';
+export * from './disposable';
+export * from './initializable';

package/src/lib/base/initializable.ts

@@ -0,0 +1,16 @@
+import { InjectionSource } from '../injectable';
+
+export abstract class IInitializable {
+  constructor() {
+    if (this.constructor == IInitializable) {
+      throw new Error("Abstract classes can't be instantiated.");
+    }
+  }
+
+  /**
+   * The method is called after field injection is complete.
+   */
+  initialize(injectionSource: InjectionSource) {
+    throw new Error("Method 'initialize(injectionSource: InjectionSource)' must be implemented.");
+  }
+}

package/src/lib/commands/command-builder.ts

@@ -0,0 +1,19 @@
+import { HttpEvent } from "@angular/common/http";
+import { Observable } from "rxjs";
+
+export interface ICommandBuilder {
+  command(name: string): ICommand;
+  fileCommand(name: string, arg: string): IFileCommand;
+}
+
+export interface ICommand {
+  arg<T>(name: string, value: T): ICommand;
+  invoke<T>(): Observable<T>;
+}
+
+export interface IFileCommand {
+  file(file: File): IFileCommand;
+  files(files: File[]): IFileCommand;
+  invoke<T>(): Observable<HttpEvent<T>>;
+}
+

package/src/lib/commands/index.ts

@@ -0,0 +1 @@
+export * from './command-builder';

package/src/lib/contexts/bim-element-panel-context.ts

@@ -0,0 +1,22 @@
+/// <reference types="@pilotdev/pilot-web-3d" />
+
+export class BimElementPanelContext {
+  private readonly _modelId: string;
+  private readonly _viewer: PilotWeb3D.Viewer3D;
+
+  constructor(
+    modelId: string,
+    viewer: PilotWeb3D.Viewer3D
+  ) {
+    this._modelId = modelId;
+    this._viewer = viewer;
+  }
+
+  get modelId(): string {
+    return this._modelId;
+  }
+
+  get viewer(): PilotWeb3D.Viewer3D {
+    return this._viewer;
+  }
+}

package/src/lib/contexts/bim-right-panel-context.ts

@@ -0,0 +1,22 @@
+/// <reference types="@pilotdev/pilot-web-3d" />
+
+export class BimRightPanelContext {
+  private readonly _modelId: string;
+  private readonly _viewer: PilotWeb3D.Viewer3D;
+
+  constructor(
+    modelId: string,
+    viewer: PilotWeb3D.Viewer3D
+  ) {
+    this._modelId = modelId;
+    this._viewer = viewer;
+  }
+
+  get modelId(): string {
+    return this._modelId;
+  }
+
+  get viewer(): PilotWeb3D.Viewer3D {
+    return this._viewer;
+  }
+}

package/src/lib/contexts/context.ts

@@ -0,0 +1,38 @@
+import { IDataObject } from "../data";
+
+
+/**
+ * Contex for objects view
+ */
+export class ObjectsViewContext {
+  private readonly _selectedObjects: IDataObject[];
+  private readonly _shortcuts: IDataObject[]; 
+  private readonly _context: IDataObject;
+  
+  constructor(selectedObjects: IDataObject[], context: IDataObject, shortcuts?: IDataObject[]) {
+    this._selectedObjects = selectedObjects;
+    this._context = context;
+    this._shortcuts = shortcuts ?? [];
+  }
+
+  /**
+   * 
+   */
+  public get selectedObjects(): IDataObject[] {
+    return this._selectedObjects;
+  }
+
+  /**
+   * 
+   */
+  public get contextObject(): IDataObject {
+    return this._context;
+  }
+
+  /**
+   * 
+   */
+  public get shortcuts(): IDataObject[] {
+    return this._shortcuts;
+  }
+}

package/src/lib/contexts/dialog-context.ts

@@ -0,0 +1,10 @@
+export class DialogContext {
+  constructor(
+    private readonly _data: unknown,
+  ) {
+  }
+
+  public get data(): unknown {
+    return this._data;
+  }
+}

package/src/lib/contexts/document-annotations-list-context.ts

@@ -0,0 +1,21 @@
+import { IAnnotationContainerObject } from "../data";
+
+
+/**
+ * Context for document annotations list
+ */
+export class DocumentAnnotationsListContext {
+  private readonly _selectedAnnotations: IAnnotationContainerObject[]; 
+  
+  constructor(selectedAnnotations: IAnnotationContainerObject[]) {
+    this._selectedAnnotations = selectedAnnotations;
+  }
+
+  /**
+   * 
+   */
+  public get selectedAnnotations(): IAnnotationContainerObject[] {
+    return this._selectedAnnotations;
+  }
+
+}

package/{lib/contexts/index.d.ts → src/lib/contexts/index.ts}

@@ -6,4 +6,4 @@ export * from './object-card-context';
 export * from './page-context';
 export * from './render-context';
 export * from './dialog-context';
-export * from './settings-feature-context';
+export * from './settings-feature-context';

package/src/lib/contexts/object-card-context.ts

@@ -0,0 +1,81 @@
+import { IAttribute, IDataObject, IType } from "../data";
+
+export class ObjectCardContext {
+  private readonly _currentObjectId: string;
+  private readonly _displayAttributes: IAttribute[];
+  private readonly _attributesValues: Map<string, unknown>;
+  private readonly _type: IType;
+  private readonly _editedObject: IDataObject | null;
+  private readonly _parentId: string;
+  private readonly _isReadOnly: boolean;
+
+  constructor(
+    currentObjectId: string,
+    displayAttributes: IAttribute[],
+    attributesValues: Map<string, unknown>,
+    type: IType,
+    editedObject: IDataObject | null,
+    parentId: string,
+    isReadOnly: boolean
+  ) {
+    this._currentObjectId = currentObjectId;
+    this._displayAttributes = displayAttributes;
+    this._attributesValues = attributesValues;
+    this._type = type;
+    this._editedObject = editedObject;
+    this._parentId = parentId;
+    this._isReadOnly = isReadOnly;
+  }
+
+  /**
+   * Current object id for which the card is shown.
+   * 
+   * It's an existing object id or a generated id that will be assigned to a new object.
+   */
+  public get currentObjectId(): string {
+    return this._currentObjectId;
+  }
+
+  /**
+   * List of all visible attributes in object's card
+   */
+  public get displayAttributes(): IAttribute[] {
+    return this._displayAttributes;
+  }
+
+  /**
+   * The set of current attributes values
+   */
+  public get attributesValues(): Map<string, unknown> {
+    return this._attributesValues;
+  }
+
+  /**
+   * Type of current object
+   */
+  public get type(): IType {
+    return this._type;
+  }
+
+  /**
+   * Current object the card is shown for. Null if card is shown to create a new object
+   */
+  public get editedObject(): IDataObject | null {
+    return this._editedObject;
+  }
+
+  /**
+   * ParentId of the current object
+   */
+  public get parentId(): string {
+    return this._parentId;
+  }
+
+  /**
+   * True if the card is shown in read only mode and not available for modification
+   */
+  public get isReadOnly(): boolean {
+    return this._isReadOnly;
+  }
+}
+

package/src/lib/contexts/page-context.ts

@@ -0,0 +1 @@
+export class PageContext {}