@pilotdev/pilot-web-sdk 26.10.0 → 26.12.0

package/lib/page-navigation/page-navigation-section.builder.d.ts

@@ -0,0 +1,33 @@
+import { IPageNavigationSectionElementBuilder } from './page-navigation-section-element.builder';
+/**
+ * Represents a builder for the navigation window's section
+ */
+export declare abstract class IPageNavigationSectionBuilder {
+    constructor();
+    /**
+     * Section's title to be displayed
+     * @param title value
+     */
+    withTitle(title: string): IPageNavigationSectionBuilder;
+    /**
+     * Gets the list of existing element ids of the section
+     * @returns Existing element ids
+     */
+    get elementIds(): string[];
+    /**
+     * Gets count of section's elements
+     */
+    get count(): number;
+    /**
+     * Adds a new element to the section
+     * @param id Element's internal id
+     * @param index The index to put the new element at
+     */
+    addElement(id: string, index: number): IPageNavigationSectionElementBuilder;
+    /**
+     * Replaces the element of the section
+     * If element does not exist - creates it
+     * @param id Elements's internal id
+     */
+    replaceElement(id: string): IPageNavigationSectionElementBuilder;
+}

package/lib/page-navigation/page-navigation.builder.d.ts

@@ -0,0 +1,28 @@
+import { IPageNavigationSectionBuilder } from './page-navigation-section.builder';
+/**
+ * Represents a builder for navigation window
+ */
+export declare abstract class IPageNavigationBuilder {
+    constructor();
+    /**
+     * Gets the list of existing section ids of the navigation window
+     * @returns Existing section ids
+     */
+    get sectionIds(): string[];
+    /**
+     * Gets count of navigation window's elements
+     */
+    get count(): number;
+    /**
+     * Adds a new section to the navigation window
+     * @param id Sections's internal id
+     * @param index The index to put the new section at
+     */
+    addSection(id: string, index: number): IPageNavigationSectionBuilder;
+    /**
+     * Replaces the section of the  navigation window
+     * If element does not exist - creates it
+     * @param id Elements's internal id
+     */
+    replaceSection(id: string): IPageNavigationSectionBuilder;
+}

package/lib/page-navigation/page-navigation.d.ts

@@ -0,0 +1,9 @@
+import { IPageNavigationBuilder } from './page-navigation.builder';
+/**
+ * Interface that allows to add new sections and elements to navigation window
+ * @exposedInterface
+ */
+export declare abstract class IPageNavigation {
+    constructor();
+    build(builder: IPageNavigationBuilder): void;
+}

package/lib/personal-settings/isettings-feature.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Extension interface that enables you to register the view on settings dialog
+ * @interface ISettingsFeature
+ * @exposedInterface
+ */
+export declare abstract class ISettingsFeature {
+    constructor();
+    /**
+     * Gets the unique id of the settings item
+     * @readonly
+     * @type {string}
+     * @memberof ISettingsFeature
+     */
+    get key(): string;
+    /**
+     * Gets the display title of the settings item
+     * @readonly
+     * @type {string}
+     * @memberof ISettingsFeature
+     */
+    get title(): string;
+    /**
+     * Gets the value editor view id for the settings feature item
+     *
+     * Is matched with corresponding IOpenspaceView's `getViewId(): string`
+     * @readonly
+     * @type {string}
+     * @memberof ISettingsFeature
+     */
+    get editorViewId(): string;
+}

package/lib/personal-settings/isettings-value-provider.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Interface for a personal setting value provider
+ * @interface ISettingValueProvider
+ */
+export declare abstract class ISettingValueProvider {
+    constructor();
+    /**
+     * Gets the current setting value.
+     * @returns {string} The current setting value.
+     */
+    getValue(): string;
+    /**
+     * Sets the setting value.
+     * @param {string} value - The new setting value.
+     */
+    setValue(value: string): void;
+}

package/lib/personal-settings/system-settings-keys.d.ts

@@ -0,0 +1,82 @@
+export declare class SystemSettingsKeys {
+    /**
+     * Get's favorites feature key
+     */
+    static readonly favoritesFeatureKey = "Favorites-880e609e-54f9-4463-9c5e-f2b742a944dc";
+    /**
+     * Get's pilot storage drive letter feature key
+     */
+    static readonly pilotStorageDriveLetter = "PilotStorageDriveLetter-880e609e-54f9-4463-9c5e-f2b742a944dc";
+    /**
+     * Get's agreement roles feature key
+     */
+    static readonly agreementRolesFeatureKey = "AgreementRoles-0a782ccd-adb3-484f-8fb2-a6c58fc5a61d";
+    /**
+     * Get's tasks filters feature key
+     */
+    static readonly tasksFiltersFeatureKey = "TasksFilters-deab09c1-2276-457b-a59b-5682baec43c7";
+    /**
+     * Get's tasks groupings feature key
+     */
+    static readonly tasksGroupingsFeatureKey = "TasksGroupings-B66B65E3-8B6D-4468-BF07-869B03E7D62B";
+    /**
+     * Get's annotation filter feature key
+     */
+    static readonly annotationFilterFeatureKey = "AnnotationFilter-F151E782-6CEB-44AF-ADF1-AFB0A0FAB95E";
+    /**
+     * Get's annotation filter feature key
+     */
+    static readonly personalAnnotationFilterFeatureKey = "PersonalAnnotationFilter-9382f499-c1b9-433f-95bb-d83195d52121";
+    /**
+     * Get's mounted on Pilot-Storage items feature key
+     */
+    static readonly mountedItemsList = "MountedItems-29eff31a-8bd2-40a2-bdac-c020db132c8b";
+    /**
+     * Get's Pilot-Storage work folders feature key
+     */
+    static readonly workfoldersList = "Workfolders-C4A424C8-AE20-4277-9CA5-94629CEB1B86";
+    /**
+     * Get's selection path of the DocumentsExplorer
+     */
+    static readonly tabsState = "TabsState-9b9e6a36-013a-423c-9599-c6edc32a5b4f";
+    /**
+     * Get's auto blocking file extensions feature key
+     */
+    static readonly autoBlockingFileExtensionsFeatureKey = "AutoBlockingFileExtensions-1bb027f4-7dd0-4aec-8c0d-cffe63bfcbb3";
+    /**
+     * Get's auto commiting file extensions feature key
+     */
+    static readonly autoCommitingFileExtensionsFeatureKey = " AutoCommitingFileExtensions-2d0de5a1-f6c1-426e-b3e6-610dfb4b2666";
+    /**
+     * Get's auto updating files feature key
+     */
+    static readonly autoUpdatingFilesFeatureKey = "AutoUpdatingFileExtensions-6FB5DE6C-96B2-4F84-8650-7A2EB102EAC5";
+    /**
+     * Get's auto publishing settings feature key
+     */
+    static readonly autoPublishingExtensionsFeatureKey = "AutoPublishingExtensions-F6FF1869-DBC2-4253-A5AA-7B225D69E416";
+    /**
+     * Get's eml attributes dictionary feature key
+     */
+    static readonly emlAttributesDictionaryKeyFeatureKey = "EmlAttributesDictionary-354AB75D-A421-4836-A343-16FEC3014A4F";
+    /**
+     * Get's documents autofill feature key
+     */
+    static readonly docsAutoFillFeatureKey = "DocsAutoFillFeatureKey-d19b557b-2109-4221-8970-794372039186";
+    /**
+     * User-defined temp files regex masks
+     */
+    static readonly tempFileMasksFeatureKey = "TempFileMasksFeatureKey-388BD8A4-E7C0-48DD-B235-8C05030CFCF3";
+    /**
+     * User-defined Export/Import settings
+     */
+    static readonly exportImportFeatureKey = "ExportImportFeatureKey-4697EA6F-E018-4989-929D-992D1176CC3C";
+    /**
+     * User-defined digital signature title
+     */
+    static readonly digitalSignatureTitleFeatureKey = "DigitalSignatureTitleFeatureKey-481EFA14-B116-434A-BAD6-F90DB883DEC9";
+    /**
+     * Enhanced signature service settings
+     */
+    static readonly advancedSignatureFeatureKey = "AdvancedSignatureFeatureKey-D267127C-DCED-4DEC-B1A8-6E7A919E383D";
+}

package/lib/tabs/tab-item.builder.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Enables to set parameters to the tab-group's item
+ */
+export declare abstract class ITabItemBuilder {
+    constructor();
+    /**
+     * Item's title to be displayed
+     * @param title value
+     */
+    withTitle(title: string): ITabItemBuilder;
+    /**
+     * Item's icon
+     * @param name Icon name
+     * @param iconSvg Url of icon or base64 string
+     */
+    withIcon(name: string, iconSvg: string): ITabItemBuilder;
+    /**
+     * Item's view id
+     *
+     * Is matched with corresponding IOpenspaceView's `getViewId(): string`
+     * @param value - View Id
+     */
+    withViewId(value: string): ITabItemBuilder;
+}

package/lib/tabs/tabs.builder.d.ts

@@ -0,0 +1,28 @@
+import { ITabItemBuilder } from './tab-item.builder';
+/**
+ * Represents a builder for tab groups
+ */
+export declare abstract class ITabsBuilder {
+    constructor();
+    /**
+     * Gets the list of existing items of a tab group
+     * @returns Existing menu item names
+     */
+    get itemNames(): string[];
+    /**
+     * Gets count of tab group items
+     */
+    get count(): number;
+    /**
+     * Adds a new item to the associated tab group
+     * @param id Item's internal id
+     * @param index The index to put the new item at
+     */
+    addItem(id: string, index: number): ITabItemBuilder;
+    /**
+     * Replaces the item for the tab group.
+     * If Item does not exist - creates it.
+     * @param id Item's internal id
+     */
+    replaceItem(id: string): ITabItemBuilder;
+}

package/lib/tabs/tabs.d.ts

@@ -0,0 +1,14 @@
+import { BimElementPanelContext, BimRightPanelContext, ObjectsViewContext } from "../contexts";
+import { ITabsBuilder } from "./tabs.builder";
+/**
+ * Interface that allows to add new items to the tabs
+ * @exposedInterface
+ */
+export declare abstract class ITabs<TTabsContext extends BimElementPanelContext | BimRightPanelContext | ObjectsViewContext> {
+    /**
+     * The method is called just before the tabs are shown
+     * @param builder The tab group builder object of associated tab group
+     * @param context Context
+     */
+    build(builder: ITabsBuilder, context: TTabsContext): void;
+}

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

@@ -1,7 +1,6 @@
-
 export * from './toolbar';
 export * from './toolbar-item.builder';
 export * from './toolbar-item-submenu.handler';
 export * from './toolbar-menu-item.builder';
 export * from './toolbar-toggle-item.builder';
-export * from './toolbar.builder';
+export * from './toolbar.builder';

package/lib/toolbar/toolbar-item-submenu.handler.d.ts

@@ -0,0 +1,9 @@
+import { IToolbarBuilder } from "./toolbar.builder";
+export declare abstract class IToolbarItemSubmenuHandler {
+    /**
+    * Build a submenu
+    * @param builder - toolbar builder
+    * @returns
+    */
+    onSubmenuRequested(builder: IToolbarBuilder): void;
+}

package/lib/toolbar/toolbar-item.builder.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Represents a toolbar button and enables to set parametres to it
+ */
+export declare abstract class IToolbarButtonItemBuilder {
+    constructor();
+    /**
+     * Item's name to be displayed
+     * @param header - value
+     * @returns instance of IToolbarButtonItemBuilder
+     */
+    withHeader(header: string): IToolbarButtonItemBuilder;
+    /**
+     * Item's icon in SVG format
+     * @param name - icon name
+     * @param svg - url icon or base64 string
+     */
+    withIcon(name: string, svg: string): IToolbarButtonItemBuilder;
+    /**
+     * Enabled the item
+     * @param value - value
+     */
+    withIsEnabled(value: boolean): IToolbarButtonItemBuilder;
+    /**
+     * Item's hint
+     * @param hint - value
+     */
+    withHint(hint: string): IToolbarButtonItemBuilder;
+}

package/lib/toolbar/toolbar-menu-item.builder.d.ts

@@ -0,0 +1,13 @@
+import { IToolbarButtonItemBuilder } from "./toolbar-item.builder";
+import { IToolbarItemSubmenuHandler } from "./toolbar-item-submenu.handler";
+/**
+ * Represents a toolbar menu button and enables to set parametres to it
+ */
+export declare abstract class IToolbarMenuButtonItemBuilder extends IToolbarButtonItemBuilder {
+    /**
+     * Build a dropdown menu
+     * @param itemSubmenuHandler - toolbar submenu handler
+     * @returns The toolbar button menu builder
+     */
+    withMenu(itemSubmenuHandler: IToolbarItemSubmenuHandler): IToolbarMenuButtonItemBuilder;
+}

package/lib/toolbar/toolbar-toggle-item.builder.d.ts

@@ -0,0 +1,11 @@
+import { IToolbarButtonItemBuilder } from "./toolbar-item.builder";
+/**
+ * Represents a toolbar toggle button and enables to set parametres to it
+ */
+export declare abstract class IToolbarToggleButtonItemBuilder extends IToolbarButtonItemBuilder {
+    /**
+     *
+     * @param value
+     */
+    withIsChecked(value: boolean): IToolbarToggleButtonItemBuilder;
+}

package/lib/toolbar/toolbar.builder.d.ts

@@ -0,0 +1,65 @@
+import { IToolbarButtonItemBuilder } from "./toolbar-item.builder";
+import { IToolbarItemSubmenuHandler } from "./toolbar-item-submenu.handler";
+import { IToolbarMenuButtonItemBuilder } from "./toolbar-menu-item.builder";
+import { IToolbarToggleButtonItemBuilder } from "./toolbar-toggle-item.builder";
+export declare abstract class IToolbarBuilder {
+    constructor();
+    /**
+     * Adds a new separator to the associated toolbar
+     * @param index - The index to put the new item at
+     */
+    addSeparator(index: number): void;
+    /**
+     * Adds a new button to the associated toolbar
+     * @param name - Internal item's name
+     * @param index - The index to put the new item at
+     */
+    addButtonItem(name: string, index: number): IToolbarButtonItemBuilder;
+    /**
+     * Adds a new menu button to the associated toolbar
+     * @param name - Internal item's name
+     * @param index - The index to put the new item at
+     */
+    addMenuButtonItem(name: string, index: number): IToolbarMenuButtonItemBuilder;
+    /**
+     * Adds a new toggle button to the associated toolbar
+     * @param name -  Internal item's name
+     * @param index - The index to put the new item at
+     */
+    addToggleButtonItem(name: string, index: number): IToolbarToggleButtonItemBuilder;
+    /**
+     * Replaces the item from the associated toolbar on button
+     * @param name - The name of toolbar button to replace
+     */
+    replaceButtonItem(name: string): IToolbarButtonItemBuilder;
+    /**
+     * Replace the item from the associated toolbar on menu button
+     * @param name - The name of toolbar menu button to replace
+     */
+    replaceMenuButtonItem(name: string): IToolbarMenuButtonItemBuilder;
+    /**
+     * Enables to set parametres to menu button item submenu
+     * @param name - Item's internal name
+     * @param itemSubmenuHandler - The toolbar button menu builder
+     */
+    handleMenuButtonItemSubmenu(name: string, itemSubmenuHandler: IToolbarItemSubmenuHandler): void;
+    /**
+     * Replaces the item from the associated toolbar on toggle button
+     * @param name - The name of toolbar toggle button to replace
+     */
+    replaceToggleButtonItem(name: string): IToolbarToggleButtonItemBuilder;
+    /**
+     * Gets the list of existing item names of associated toolbar
+     * @returns - Existing toolbar item names
+     */
+    get itemNames(): string[];
+    /**
+     * Gets count of toolbar items
+     */
+    get count(): number;
+    /**
+     * Removes specified item
+     * @param itemName - Item's internal name
+     */
+    removeItem(itemName: string): void;
+}

package/lib/toolbar/toolbar.d.ts

@@ -0,0 +1,21 @@
+import { DocumentAnnotationsListContext, ObjectsViewContext } from "../contexts";
+import { IToolbarBuilder } from "./toolbar.builder";
+/**
+ * Interface that allows to add new items to the toolbar
+ * @exposedInterface
+ */
+export declare abstract class IToolbar<TToolbarContext extends ObjectsViewContext | DocumentAnnotationsListContext> {
+    constructor();
+    /**
+     * The method is called just before the toolbar is created
+     * @param builder - the toolbar builder object of associated toolbar
+     * @param context - context
+     */
+    build(builder: IToolbarBuilder, context: TToolbarContext): void;
+    /**
+     *
+     * @param name
+     * @param context
+     */
+    onToolbarItemClick(name: string, context: TToolbarContext): void;
+}

package/lib/tools/attribute-permission.info.d.ts

@@ -0,0 +1,9 @@
+import { IDataObject } from "../data";
+export declare class AttributePermissionInfo {
+    private ATTRIBUTE_NAME_MARKER;
+    orgUnits: number[];
+    orgUnitAttributes: string[];
+    constructor(editableForPositionsSource: string[]);
+    extractAllOrgUnits(obj: IDataObject): number[];
+    extractAllOrgUnitsByAttributes(attributes: Map<string, any>): number[];
+}

package/lib/tools/guid.d.ts

@@ -0,0 +1,7 @@
+export declare class Guid {
+    private static readonly regex;
+    static readonly EMPTY = "00000000-0000-0000-0000-000000000000";
+    static newGuid(): string;
+    static isGuid(str: string): boolean;
+    private static stringify;
+}

package/lib/tools/index.d.ts

@@ -0,0 +1,3 @@
+export * from './attribute-permission.info';
+export * from './utils';
+export * from './guid';

package/lib/tools/utils.d.ts

@@ -0,0 +1,3 @@
+export declare function objectToMap<T>(objectMap: {
+    [key: string]: any;
+}): Map<string, T>;

package/package.json

@@ -1,14 +1,27 @@
 {
   "name": "@pilotdev/pilot-web-sdk",
-  "version": "26.10.0",
+  "version": "26.12.0",
   "peerDependencies": {
     "@angular/common": "17.3.12",
     "@angular/core": "17.3.12",
-    "@pilotdev/pilot-web-3d": "26.8.0",
+    "@pilotdev/pilot-web-3d": "26.8.18-alpha",
     "rxjs": "7.8.1"
   },
   "dependencies": {
     "tslib": "2.3.0"
   },
-  "sideEffects": false
-}
+  "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"
+    }
+  }
+}

package/{src/public-api.ts → public-api.d.ts}

@@ -1,6 +1,3 @@
-/*
- * Public API Surface of pilot-web-sdk
- */
 export * from './lib/base/index';
 export * from './lib/idata.plugin';
 export * from './lib/icrypto-provider';

package/.eslintrc.json

@@ -1,31 +0,0 @@
-{
-  "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/ng-package.json

@@ -1,10 +0,0 @@
-{
-  "$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/src/lib/base/disposable.ts

@@ -1,14 +0,0 @@
-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/src/lib/base/initializable.ts

@@ -1,16 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

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

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

@@ -1,22 +0,0 @@
-/// <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

@@ -1,22 +0,0 @@
-/// <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;
-  }
-}