@pilotdev/pilot-web-sdk 24.4.0 → 24.9.0

package/lib/contexts/context.d.ts

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

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

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

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

@@ -1,3 +1,3 @@
 export * from './context';
 export * from './document-annotations-list-context';
-export * from './render-context';
+export * from './render-context';

package/lib/contexts/render-context.d.ts

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

package/lib/data/access.d.ts

@@ -0,0 +1,35 @@
+export declare enum AccessLevel {
+    None = 0,
+    Create = 1,
+    Edit = 2,
+    View = 4,
+    Freeze = 8,
+    Agreement = 16,
+    Share = 32,
+    ViewCreate = 5,
+    ViewEdit = 7,
+    ViewEditAgrement = 23,
+    Full = 63
+}
+export declare enum AccessType {
+    Allow = 0,
+    Deny = 1
+}
+export declare enum AccessInheritance {
+    None = 0,
+    InheritUntilSecret = 1,
+    InheritWholeSubtree = 2
+}
+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/lib/data/annotations.d.ts

@@ -0,0 +1,15 @@
+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/lib/data/attribute.d.ts

@@ -0,0 +1,30 @@
+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 declare 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/lib/data/data-object.d.ts

@@ -0,0 +1,74 @@
+import { AccessLevel, IAccessRecord } from "./access";
+import { IAttribute } from "./attribute";
+import { IFileSnapshot } from "./files-snapshot";
+import { IPerson } from "./person";
+import { IRelation } from "./relation";
+export declare enum RelationType {
+    SourceFiles = 1,
+    TaskInitiatorAttachments = 2,
+    TaskExecutorAttachments = 3,
+    MessageAttachments = 4,
+    Custom = 5,
+    TaskAttachments = 6
+}
+export declare enum ObjectState {
+    Alive = 0,
+    InRecycleBin = 1,
+    DeletedPermanently = 2,
+    Frozen = 3,
+    LockRequested = 4,
+    LockAccepted = 5
+}
+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/lib/data/file.d.ts

@@ -0,0 +1,23 @@
+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/lib/data/files-snapshot.d.ts

@@ -0,0 +1,8 @@
+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/index.ts → lib/data/index.d.ts}

@@ -8,5 +8,5 @@ export * from './person';
 export * from './relation';
 export * from './object-builder';
 export * from './modifier';
-export * from './organisation-unit'
-export * from './subscriptionType'
+export * from './organisation-unit';
+export * from './subscriptionType';

package/lib/data/modifier.d.ts

@@ -0,0 +1,30 @@
+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[]>;
+}

package/lib/data/object-builder.d.ts

@@ -0,0 +1,110 @@
+import { AttributeType } from "./attribute";
+import { IAnnotationContainer } from "./annotations";
+import { IAccessRecord } from "./access";
+import { IRelation } from "./relation";
+/**
+ * Fluent interface that enables you to modify the associated object
+ */
+export interface IObjectBuilder {
+    /**
+     * Sets the string attribute value
+     *
+     * @param name  Attribute name
+     * @param value  Attribute value
+     * @returns Self
+     */
+    setAttribute(name: string, value: any, type: AttributeType): IObjectBuilder;
+    /**
+     * Adds access record to an object
+     *
+     * @param record  Access record
+     * @returns Self
+     */
+    setAccess(record: IAccessRecord): IObjectBuilder;
+    /**
+     * Removes access record
+     *
+     * @param record  Access record
+     * @returns Self
+     */
+    removeAccess(record: IAccessRecord): IObjectBuilder;
+    /**
+     * Adds a relation
+     *
+     * @param relation  Relation
+     * @returns Self
+     */
+    addRelation(relation: IRelation): IObjectBuilder;
+    /**
+     * Removes relation
+     *
+     * @param relationId  Relation id
+     * @returns Self
+     */
+    removeRelation(relationId: string): IObjectBuilder;
+    /**
+     * Sets new type. It is recommended to use this method only for recovering permanently deleted objects. In other cases, this can lead to system malfunction.
+     *
+     * @param typeId  Type id
+     * @returns Self
+     */
+    setTypeId(typeId: number): IObjectBuilder;
+    /**
+     * Sets new parent
+     *
+     * @param parentId  Parent id
+     * @returns Self
+     */
+    setParentId(parentId: string): IObjectBuilder;
+    /**
+     * Adds file snapshot
+     *
+     * @param reason  Reason
+     * @returns Self
+     */
+    createSnapshot(reason: string): IObjectBuilder;
+    /**
+     * Makes file snapshot actual
+     *
+     * @param version  Version of file snapshot to make actual
+     * @param reason  Reason
+     * @returns Self
+     */
+    createSnapshotFrom(version: string, reason: string): IObjectBuilder;
+    /**
+    * Sets permanently deleted flag
+    *
+    * @param isDeleted  Value
+    * @returns Self
+    */
+    setIsDeleted(isDeleted: boolean): IObjectBuilder;
+    /**
+     * Set flag in recycle bin
+     *
+     * @param isInRecycleBin  Value
+     * @returns Self
+     */
+    setIsInRecycleBin(isInRecycleBin: boolean): IObjectBuilder;
+    /**
+     * Sets frozen flag
+     *
+     * @param isFreezed Value
+     * @returns Self
+     */
+    setIsFreezed(isFreezed: boolean): IObjectBuilder;
+    /**
+     * Sets object's secret info
+     *
+     * @param isSecret Value
+     * @returns Self
+     */
+    setIsSecret(isSecret: boolean): IObjectBuilder;
+    /**
+     * Adds or changes a annotation
+     *
+     * @param container Annotation container
+     * @param attrbutes Annotation attributes
+     * @returns Self
+     */
+    addAnnotationContainer(container: IAnnotationContainer, attrbutes: any): IObjectBuilder;
+}

package/lib/data/organisation-unit.d.ts

@@ -0,0 +1,18 @@
+export interface IOrganizationUnit {
+    get id(): number;
+    get title(): string;
+    get kind(): OrgUnitKind;
+    get children(): number[];
+    get isDeleted(): boolean;
+    get isBoss(): boolean;
+    get version(): number;
+    get person(): number;
+    get vicePersons(): number[];
+    get isCanceled(): boolean;
+    get groupPersons(): number[];
+}
+export declare enum OrgUnitKind {
+    Department = 0,
+    Position = 1,
+    Group = 2
+}

package/lib/data/person.d.ts

@@ -0,0 +1,17 @@
+export interface IPerson {
+    get id(): number;
+    get login(): string;
+    get isInactive(): boolean;
+    get displayName(): string;
+    get positions(): number[];
+    get groups(): number[];
+    get bossOf(): number[];
+    get allOrgUnits(): number[];
+    get comment(): string;
+    get email(): string;
+    get sid(): string;
+    get uidDn(): string;
+    get isDeleted(): boolean;
+    get isAdmin(): boolean;
+    get version(): number;
+}

package/lib/data/relation.d.ts

@@ -0,0 +1,8 @@
+import { RelationType } from "./data-object";
+export interface IRelation {
+    get id(): string;
+    get targetId(): string;
+    get type(): RelationType;
+    get name(): string;
+    get versionId(): string;
+}

package/lib/data/subscriptionType.d.ts

@@ -0,0 +1,4 @@
+export declare enum SubscriptionType {
+    Shallow = 0,
+    Deep = 1
+}

package/lib/idata.plugin.d.ts

@@ -0,0 +1,2 @@
+export interface IDataPlugin {
+}

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

@@ -1,4 +1,4 @@
 export * from './objects-repository';
 export * from './render-context-provider';
-export * from './modifier-provider'
-export * from './repository-events'
+export * from './modifier-provider';
+export * from './repository-events';

package/{src/lib/injectable/modifier-provider.ts → lib/injectable/modifier-provider.d.ts}

@@ -1,11 +1,10 @@
 import { IModifier } from "../data/modifier";
-
 /**
  * Provides modifier
  */
 export interface IModifierProvider {
-  /**
-   * 
-   */
-  newModifier(): IModifier;
-}
+    /**
+     *
+     */
+    newModifier(): IModifier;
+}

package/lib/injectable/objects-repository.d.ts

@@ -0,0 +1,72 @@
+import { Observable } from "rxjs";
+import { AccessLevel } from "../data/access";
+import { IDataObject, IPerson, IType, IOrganizationUnit } from "../data";
+/**
+ * Represents the repository that provides access to objects, types, organisation units and people
+ */
+export interface IObjectsRepository {
+    /**
+     * Get objects with specified ids
+     *
+     * @param ids Ids of objects to subsribe
+     * @returns
+     */
+    getObjects(ids: string[]): Observable<IDataObject[]>;
+    /**
+     * Get object's access for the person
+     *
+     * @param objectId Object id
+     * @param personId Person Id
+     * @returns Cold Observable
+     */
+    getCurrentAccess(objectId: string, personId: number): Observable<AccessLevel>;
+    /**
+     * Gets the person with specified id
+     *
+     * @param id Person id
+     * @returns Person
+     */
+    getPerson(id: number): IPerson;
+    /**
+     * Gets the current person
+     *
+     * @returns Person
+     */
+    getCurrentPerson(): IPerson;
+    /**
+     * Gets all the people registred in database
+     *
+     * @returns Person[]
+     */
+    getPeople(): IPerson[];
+    /**
+     * Gets type by identifier
+     *
+     * @returns Type
+     */
+    getType(id: number): IType;
+    /**
+     * Gets type by name
+     *
+     * @returns Type
+     */
+    getTypeByName(name: string): IType;
+    /**
+     * Gets all the types registered in database
+     *
+     * @returns Type[]
+     */
+    getTypes(): IType[];
+    /**
+     * Gets organisation unit by identifier
+     *
+     * @returns OrganisationUnit
+     */
+    getOrganisationUnit(id: number): IOrganizationUnit;
+    /**
+     * Get all the organisation units registered in database
+     *
+     * @returns OrganisationUnit
+     */
+    getOrganisationUnits(): IOrganizationUnit[];
+}

package/lib/injectable/render-context-provider.d.ts

@@ -0,0 +1,10 @@
+import { RenderContext } from "../contexts/render-context";
+/**
+ * Provides render context
+ */
+export interface IRenderContextProvider {
+    /**
+     *
+     */
+    getRenderContext(): RenderContext;
+}

package/lib/injectable/repository-events.d.ts

@@ -0,0 +1,31 @@
+import { Observable } from "rxjs";
+import { IDataObject, IPerson, IType, IOrganizationUnit } from "../data";
+/**
+ * Notifies on change events
+ */
+export interface IRepositoryEvents {
+    /**
+     * Subsribes to changes in objects with specified identifiers
+     *
+     * @returns Hot observable
+     */
+    subscribeObjects(ids: string[]): Observable<IDataObject>;
+    /**
+     * Subsribes to changes in people
+     *
+     * @returns Hot observable
+     */
+    subscribePeople(): Observable<IPerson>;
+    /**
+     * Subsribes to changes in types
+     *
+     * @returns Hot observable
+     */
+    subscribeTypes(): Observable<IType>;
+    /**
+     * Subsribes to changes in organisation units
+     *
+     * @returns Hot observable
+     */
+    subscribeOrganisationUnits(): Observable<IOrganizationUnit>;
+}

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

@@ -0,0 +1,11 @@
+import { IMenuItemBuilder } from "./menu-item.builder";
+/**
+ *
+ */
+export declare abstract class ICheckableMenuItemBuilder extends IMenuItemBuilder {
+    /**
+     *
+     * @param value
+     */
+    withIsChecked(value: boolean): ICheckableMenuItemBuilder;
+}

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

@@ -1,5 +1,4 @@
-
 export * from './menu';
 export * from './checkable-menu.builder';
 export * from './menu-item.builder';
-export * from './menu.builder';
+export * from './menu.builder';

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

@@ -0,0 +1,27 @@
+import { IMenuBuilder } from "./menu.builder";
+/**
+ * Represents a menu item and enables to set parametres to it
+ */
+export declare abstract class IMenuItemBuilder {
+    constructor();
+    /**
+     * Item's name to be displayed
+     * @param header value
+     */
+    withHeader(header: string): IMenuItemBuilder;
+    /**
+     * Item's icon
+     * @param name Icon name
+     * @param iconSvg Url of icon or base64 string
+     */
+    withIcon(name: string, iconSvg: string): IMenuItemBuilder;
+    /**
+     * Enabled the item
+     * @param value value
+     */
+    withIsEnabled(value: boolean): IMenuItemBuilder;
+    /**
+     * Item's submenu
+     */
+    withSubmenu(): IMenuBuilder;
+}