@pilotdev/pilot-web-sdk 24.4.0 → 24.9.0

package/lib/menu/menu.builder.d.ts

@@ -0,0 +1,49 @@
+import { ICheckableMenuItemBuilder } from "./checkable-menu.builder";
+import { IMenuItemBuilder } from "./menu-item.builder";
+/**
+ * Represents a menu and enables to add new items to it
+ */
+export declare abstract class IMenuBuilder {
+    constructor();
+    /**
+     * Gets the list of existing items of associated menu or subitems of an item
+     * @returns Existing menu item names
+     */
+    get itemNames(): string[];
+    /**
+     * Gets count of menu items
+     */
+    get count(): number;
+    /**
+     * Adds a new separator to the associated menu
+     * @param index The index to put the new item at
+     */
+    addSeparator(index: number): void;
+    /**
+     * Adds a new item to the associated menu
+     * @param name Item's internal name
+     * @param index The index to put the new item at
+     */
+    addItem(name: string, index: number): IMenuItemBuilder;
+    /**
+     * Adds a new checkable item to the associated menu
+     * @param name Item's internal name
+     * @param index The index to put the new item at
+     */
+    addCheckableItem(name: string, index: number): ICheckableMenuItemBuilder;
+    /**
+     * Replaces the item to the associated menu
+     * @param name Item's internal name
+     */
+    replaceItem(name: string): IMenuItemBuilder;
+    /**
+     * Removes the item with the specified name
+     * @param name Item's internal name
+     */
+    removeItem(name: string): void;
+    /**
+     * Gets the item
+     * @param name Item's internal name
+     */
+    getItem(name: string): IMenuBuilder;
+}

package/lib/menu/menu.d.ts

@@ -0,0 +1,18 @@
+import { IMenuBuilder } from "./menu.builder";
+/**
+ * Interface that allows to add new items to the menu and context menus
+ */
+export declare abstract class IMenu<TMenuContext> {
+    /**
+     * The method is called just before the menu is shown
+     * @param builder The menu builder object of associated menu
+     * @param context Context
+     */
+    build(builder: IMenuBuilder, context: TMenuContext): void;
+    /**
+     *
+     * @param name
+     * @param context
+     */
+    onMenuItemClick(name: string, context: TMenuContext): 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,19 @@
+import { IToolbarBuilder } from "./toolbar.builder";
+/**
+ * Interface that allows to add new items to the toolbar
+ */
+export declare abstract class IToolbar<TToolbarContext> {
+    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,8 @@
+export declare class AttributePermissionInfo {
+    private ATTRIBUTE_NAME_MARKER;
+    orgUnits: number[];
+    orgUnitAttributes: string[];
+    constructor(editableForPositionsSource: string[]);
+    extractAllOrgUnits(obj: any): 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,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-sdk",
-  "version": "24.4.0",
+  "version": "24.9.0",
   "peerDependencies": {
     "@angular/common": "^15.1.4",
     "@angular/core": "^15.1.4",
@@ -9,5 +9,24 @@
   "dependencies": {
     "tslib": "^2.3.0"
   },
-  "sideEffects": false
-}
+  "sideEffects": false,
+  "module": "fesm2015/pilotdev-pilot-web-sdk.mjs",
+  "es2020": "fesm2020/pilotdev-pilot-web-sdk.mjs",
+  "esm2020": "esm2020/pilotdev-pilot-web-sdk.mjs",
+  "fesm2020": "fesm2020/pilotdev-pilot-web-sdk.mjs",
+  "fesm2015": "fesm2015/pilotdev-pilot-web-sdk.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2020": "./esm2020/pilotdev-pilot-web-sdk.mjs",
+      "es2020": "./fesm2020/pilotdev-pilot-web-sdk.mjs",
+      "es2015": "./fesm2015/pilotdev-pilot-web-sdk.mjs",
+      "node": "./fesm2015/pilotdev-pilot-web-sdk.mjs",
+      "default": "./fesm2020/pilotdev-pilot-web-sdk.mjs"
+    }
+  }
+}

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

@@ -1,10 +1,7 @@
-/*
- * Public API Surface of pilot-web-sdk
- */
 export * from './lib/idata.plugin';
 export * from './lib/injectable/index';
 export * from './lib/toolbar/index';
 export * from './lib/menu/index';
 export * from './lib/contexts/index';
 export * from './lib/tools/index';
-export * from './lib/data/index';
+export * from './lib/data/index';

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,7 +0,0 @@
-{
-  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-  "dest": "../../dist/pilot-web-sdk",
-  "lib": {
-    "entryFile": "src/public-api.ts"
-  }
-}

package/src/lib/contexts/context.ts

@@ -1,38 +0,0 @@
-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/document-annotations-list-context.ts

@@ -1,21 +0,0 @@
-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/src/lib/contexts/render-context.ts

@@ -1,28 +0,0 @@
-import { IDataObject } from "../data";
-
-/**
- * Context for xps render
- */
-export class RenderContext {
-  private readonly _dataObject: IDataObject;
-  private readonly _selectedVersion: string;
-  
-  constructor(dataObject: IDataObject, selectedVersion: string) {
-    this._dataObject = dataObject;
-    this._selectedVersion = selectedVersion;
-  }
-
-   /**
-    * Target object
-    */
-  public get dataObject(): IDataObject {
-    return this._dataObject;
-  }
-
-   /**
-    * Selected version time
-    */
-  public get selectedVersion(): string {
-    return this._selectedVersion;
-  }
-}

package/src/lib/data/access.ts

@@ -1,40 +0,0 @@
-export enum AccessLevel {
-  None = 0,
-  Create = 1 << 0,
-  Edit = 1 << 1,
-  View = 1 << 2,
-  Freeze = 1 << 3,
-  Agreement = 1 << 4,
-  Share = 1 << 5,
-
-  ViewCreate = View | Create,
-  ViewEdit = View | Create | Edit,
-  ViewEditAgrement = ViewEdit | Agreement,
-  Full = View | Create | Edit | Freeze | Agreement | Share
-}
-
-export enum AccessType {
-  Allow,
-  Deny
-}
-
-export enum AccessInheritance {
-  None,
-  InheritUntilSecret,
-  InheritWholeSubtree
-}
-
-export interface IAccessRecord {
-  get orgUnitId(): number;
-  get access(): IAccess;
-  get recordOwnerPosition(): number;
-  get inheritanceSource(): string;
-}
-
-export interface IAccess {
-  get type(): AccessType;
-  get accessLevel(): AccessLevel;
-  get validThrough(): string;
-  get inheritance(): AccessInheritance;
-  get typeIds(): number[];
-}

package/src/lib/data/annotations.ts

@@ -1,20 +0,0 @@
-import { IDataObject } from "./data-object";
-
-
-export interface IAnnotationContainerObject {
-  get container(): IAnnotationContainer;
-  get source(): IDataObject;
-  get attributes(): any;
-}
-
-
-export interface IAnnotationContainer {
-  get annotationId(): string;
-  get version(): string;
-  get positionX(): number;
-  get positionY(): number;
-  get pageNumber(): number;
-  get data(): string;
-  get kind(): string;
-}
-

package/src/lib/data/attribute.ts

@@ -1,33 +0,0 @@
-
-export interface IAttribute {
-  get name(): string;
-  get title(): string;
-  get obligatory(): boolean;
-  get type(): AttributeType;
-  get displayHeight(): number;
-  get showInTree(): boolean;
-  get displaySortOrder(): number;
-  get isService(): boolean;
-  get configuration(): string;
-  get joinWithPrevious(): boolean;
-  get isUnique(): boolean;
-  get groupTitle(): string;
-  get editableForPositionsSource(): string[];
-}
-
-
-export enum AttributeType {
-  Integer = 0,
-  Double = 1,
-  DateTime = 2,
-  String = 3,
-  Decimal = 4,
-  Numerator = 5,
-  Array = 6,
-  UserState = 7,
-  OrgUnit = 8,
-  ElementBook = 9,
-  Guid = 10,
-  IntegerArray = 11,
-  Unknown = 99
-}

package/src/lib/data/data-object.ts

@@ -1,78 +0,0 @@
-import { AccessLevel, IAccessRecord } from "./access";
-import { IAttribute } from "./attribute";
-import { IFileSnapshot } from "./files-snapshot";
-import { IPerson } from "./person";
-import { IRelation } from "./relation";
-
-
-export enum RelationType {
-  SourceFiles = 1,
-  TaskInitiatorAttachments = 2,
-  TaskExecutorAttachments = 3,
-  MessageAttachments = 4,
-  Custom = 5,
-  TaskAttachments = 6,
-}
-
-export enum ObjectState {
-  Alive,
-  InRecycleBin,
-  DeletedPermanently,
-  Frozen,
-  LockRequested,
-  LockAccepted
-}
-
-export interface IDataObject {
-  get id(): string;
-  get parentId(): string;
-  get title(): string;
-  get type(): IType;
-  get attributes(): { [key: string]: any; };
-  get children(): IChild[];
-  get creator(): IPerson;
-  get created(): string;
-  get actualFileSnapshot(): IFileSnapshot;
-  get previousFileSnapshots(): IFileSnapshot[];
-  get context(): string[];
-  get relations(): IRelation[];
-  get access(): IAccessRecord[];
-  get accessLevels(): { [key: number]: AccessLevel; };
-  get stateInfo(): IStateInfo;
-  get secretInfo(): ISecretInfo;
-}
-
-export interface IType {
-  get id(): number;
-  get title(): string;
-  get name(): string;
-  get icon(): string;
-  get sort(): number;
-  get hasFiles(): boolean;
-  get children(): number[];
-  get attributes(): IAttribute[];
-  get isDeleted(): boolean;
-  get kind(): number;
-  get isMountable(): boolean;
-  get isService(): boolean;
-  get isProject(): boolean;
-  get configuration(): string;
-}
-
-export interface IChild {
-  get objectId(): string;
-  get typeId(): number;
-}
-
-export interface ISecretInfo {
-  get isSecret(): boolean;
-  get secretParentId(): string;
-  get secretChangedBy(): number;
-}
-
-export interface IStateInfo {
-  get state(): ObjectState;
-  get date(): string;
-  get personId(): number;
-  get positionId(): number;
-}

package/src/lib/data/file.ts

@@ -1,25 +0,0 @@
-export interface IFile {
-  get body(): IFileBody;
-  get name(): string;
-  get signatures(): ISignature[];
-}
-
-export interface IFileBody {
-  get id(): string;
-  get size(): number;
-  get md5(): any;
-  get modified(): string;
-  get created(): string;
-  get accessed(): string;
-}
-
-export interface ISignature {
-  get id(): string;
-  get databaseId(): string;
-  get positionId(): number;
-  get role(): string;
-  get sign(): string;
-  get requestedSigner(): string;
-  get isAdditional(): boolean;
-  get objectId(): string;
-}

package/src/lib/data/files-snapshot.ts

@@ -1,9 +0,0 @@
-import { IFile } from "./file";
-
-export interface IFileSnapshot {
-  get created(): string;
-  get creatorId(): number;
-  get reason(): string;
-  get files(): IFile[];
-  get hasAnnotations(): boolean;
-}

package/src/lib/data/modifier.ts

@@ -1,31 +0,0 @@
-import { Observable } from "rxjs/internal/Observable";
-import { IDataObject } from ".";
-import { IObjectBuilder } from "./object-builder";
-
-/**
- * Creates, modifies and deletes objects
- */
-export interface IModifier {
-  /**
-   * Creates a new object
-   * 
-   * @param id New object id
-   * @param parentId Parent id
-   * @param typeId Creating object's type id
-   * @return Fluent interface that enables you to modify created object
-   */
-  create(id: string, parentId: string, typeId: number): IObjectBuilder;
-  /**
-   * Edits existing object
-   * 
-   * @param id Id of object to modify
-   * @returns Fluent interface that enables you to modify created object
-   */
-  edit(id: string) : IObjectBuilder;
-  /**
-   * Applies all the changes have been made in modifier
-   * 
-   * @returns Created and edited objects wrapped in cold Observable
-   */
-  apply(): Observable<IDataObject[]>;
-}