@itwin/presentation-frontend 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/cjs/presentation-frontend/favorite-properties/FavoritePropertiesManager.d.ts

@@ -1,133 +1,133 @@
-/** @packageDocumentation
- * @module Core
- */
-import { BeEvent, IDisposable } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { Field } from "@itwin/presentation-common";
-import { IFavoritePropertiesStorage } from "./FavoritePropertiesStorage";
-/**
- * Scopes that favorite properties can be stored in.
- * @public
- */
-export declare enum FavoritePropertiesScope {
-    Global = 0,
-    ITwin = 1,
-    IModel = 2
-}
-/**
- * Format:
- * Regular property - [{path from parent class}-]{schema name}:{class name}:{property name}.
- * Nested property - [{path from parent class}-]{content class schema name}:{content class name}.
- * Primitive property - {field name}.
- * @public
- */
-export declare type PropertyFullName = string;
-/**
- * Holds the information of favorite properties ordering.
- * @public
- */
-export interface FavoritePropertiesOrderInfo {
-    parentClassName: string | undefined;
-    name: PropertyFullName;
-    priority: number;
-    orderedTimestamp: Date;
-}
-/**
- * Properties for initializing [[FavoritePropertiesManager]]
- * @public
- */
-export interface FavoritePropertiesManagerProps {
-    /**
-     * Implementation of a persistence layer for storing favorite properties and their order.
-     * @public
-     */
-    storage: IFavoritePropertiesStorage;
-}
-/**
- * The favorite property manager which lets to store favorite properties
- * and check if field contains favorite properties.
- *
- * @public
- */
-export declare class FavoritePropertiesManager implements IDisposable {
-    /**
-     * Used in tests to avoid collisions between multiple runs using the same storage
-     * @internal
-     */
-    static FAVORITES_IDENTIFIER_PREFIX: string;
-    /** Event raised after favorite properties have changed. */
-    onFavoritesChanged: BeEvent<() => void>;
-    private _storage;
-    private _globalProperties;
-    private _iTwinProperties;
-    private _imodelProperties;
-    private _imodelBaseClassesByClass;
-    /** Property order is saved only in iModel scope */
-    private _propertiesOrder;
-    constructor(props: FavoritePropertiesManagerProps);
-    dispose(): void;
-    /**
-     * Initialize favorite properties for the provided IModelConnection.
-     */
-    initializeConnection: (imodel: IModelConnection) => Promise<void>;
-    /**
-     * Function that removes order information of properties that are no longer
-     * favorited and adds missing order information for favorited properties.
-     */
-    private _adjustPropertyOrderInfos;
-    private validateInitialization;
-    /**
-     * Adds favorite properties into a certain scope.
-     * @param field Field that contains properties. If field contains multiple properties, all of them will be favorited.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to put the favorite properties into.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
-    /**
-     * Removes favorite properties from a scope specified and all the more general scopes.
-     * @param field Field that contains properties. If field contains multiple properties, all of them will be un-favorited.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to remove the favorite properties from. It also removes from more general scopes.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    remove(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
-    /**
-     * Removes all favorite properties from a certain scope.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to remove the favorite properties from.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    clear(imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
-    /**
-     * Check if field contains at least one favorite property.
-     * @param field Field that contains properties.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    has(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): boolean;
-    /**
-     * Sorts an array of fields with respect to favorite property order.
-     * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
-     * @param imodel IModelConnection.
-     * @param fields Array of Field's that needs to be sorted.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    sortFields: (imodel: IModelConnection, fields: Field[]) => Field[];
-    private getFieldPriority;
-    private _getBaseClassesByClass;
-    /** Changes field properties priorities to lower than another fields priority
-     * @param imodel IModelConnection.
-     * @param field Field that priority is being changed.
-     * @param afterField Field that goes before the moved field. If undefined the moving field is changed to the highest priority (to the top).
-     * @param visibleFields Array of fields to move the field in.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    changeFieldPriority(imodel: IModelConnection, field: Field, afterField: Field | undefined, visibleFields: Field[]): Promise<void>;
-}
-/** @internal */
-export declare const getFieldInfos: (field: Field) => Set<PropertyFullName>;
-/** @internal */
-export declare const createFieldOrderInfos: (field: Field) => FavoritePropertiesOrderInfo[];
+/** @packageDocumentation
+ * @module Core
+ */
+import { BeEvent, IDisposable } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { Field } from "@itwin/presentation-common";
+import { IFavoritePropertiesStorage } from "./FavoritePropertiesStorage";
+/**
+ * Scopes that favorite properties can be stored in.
+ * @public
+ */
+export declare enum FavoritePropertiesScope {
+    Global = 0,
+    ITwin = 1,
+    IModel = 2
+}
+/**
+ * Format:
+ * Regular property - [{path from parent class}-]{schema name}:{class name}:{property name}.
+ * Nested property - [{path from parent class}-]{content class schema name}:{content class name}.
+ * Primitive property - {field name}.
+ * @public
+ */
+export type PropertyFullName = string;
+/**
+ * Holds the information of favorite properties ordering.
+ * @public
+ */
+export interface FavoritePropertiesOrderInfo {
+    parentClassName: string | undefined;
+    name: PropertyFullName;
+    priority: number;
+    orderedTimestamp: Date;
+}
+/**
+ * Properties for initializing [[FavoritePropertiesManager]]
+ * @public
+ */
+export interface FavoritePropertiesManagerProps {
+    /**
+     * Implementation of a persistence layer for storing favorite properties and their order.
+     * @public
+     */
+    storage: IFavoritePropertiesStorage;
+}
+/**
+ * The favorite property manager which lets to store favorite properties
+ * and check if field contains favorite properties.
+ *
+ * @public
+ */
+export declare class FavoritePropertiesManager implements IDisposable {
+    /**
+     * Used in tests to avoid collisions between multiple runs using the same storage
+     * @internal
+     */
+    static FAVORITES_IDENTIFIER_PREFIX: string;
+    /** Event raised after favorite properties have changed. */
+    onFavoritesChanged: BeEvent<() => void>;
+    private _storage;
+    private _globalProperties;
+    private _iTwinProperties;
+    private _imodelProperties;
+    private _imodelBaseClassesByClass;
+    /** Property order is saved only in iModel scope */
+    private _propertiesOrder;
+    constructor(props: FavoritePropertiesManagerProps);
+    dispose(): void;
+    /**
+     * Initialize favorite properties for the provided IModelConnection.
+     */
+    initializeConnection: (imodel: IModelConnection) => Promise<void>;
+    /**
+     * Function that removes order information of properties that are no longer
+     * favorited and adds missing order information for favorited properties.
+     */
+    private _adjustPropertyOrderInfos;
+    private validateInitialization;
+    /**
+     * Adds favorite properties into a certain scope.
+     * @param field Field that contains properties. If field contains multiple properties, all of them will be favorited.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to put the favorite properties into.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
+    /**
+     * Removes favorite properties from a scope specified and all the more general scopes.
+     * @param field Field that contains properties. If field contains multiple properties, all of them will be un-favorited.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to remove the favorite properties from. It also removes from more general scopes.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    remove(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
+    /**
+     * Removes all favorite properties from a certain scope.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to remove the favorite properties from.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    clear(imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
+    /**
+     * Check if field contains at least one favorite property.
+     * @param field Field that contains properties.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    has(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): boolean;
+    /**
+     * Sorts an array of fields with respect to favorite property order.
+     * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
+     * @param imodel IModelConnection.
+     * @param fields Array of Field's that needs to be sorted.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    sortFields: (imodel: IModelConnection, fields: Field[]) => Field[];
+    private getFieldPriority;
+    private _getBaseClassesByClass;
+    /** Changes field properties priorities to lower than another fields priority
+     * @param imodel IModelConnection.
+     * @param field Field that priority is being changed.
+     * @param afterField Field that goes before the moved field. If undefined the moving field is changed to the highest priority (to the top).
+     * @param visibleFields Array of fields to move the field in.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    changeFieldPriority(imodel: IModelConnection, field: Field, afterField: Field | undefined, visibleFields: Field[]): Promise<void>;
+}
+/** @internal */
+export declare const getFieldInfos: (field: Field) => Set<PropertyFullName>;
+/** @internal */
+export declare const createFieldOrderInfos: (field: Field) => FavoritePropertiesOrderInfo[];
 //# sourceMappingURL=FavoritePropertiesManager.d.ts.map

package/lib/cjs/presentation-frontend/favorite-properties/FavoritePropertiesManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FavoritePropertiesManager.d.ts","sourceRoot":"","sources":["../../../../src/presentation-frontend/favorite-properties/FavoritePropertiesManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAiB,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,KAAK,EAAuC,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEzE;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,IAAA;IACN,KAAK,IAAA;IACL,MAAM,IAAA;CACP;AAED;;;;;;GAMG;AACH,oBAAY,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,OAAO,EAAE,0BAA0B,CAAC;CACrC;AAED;;;;;GAKG;AACH,qBAAa,yBAA0B,YAAW,WAAW;IAC3D;;;OAGG;IACH,OAAc,2BAA2B,SAAM;IAE/C,2DAA2D;IACpD,kBAAkB,gBAAqB,IAAI,EAAI;IAEtD,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,iBAAiB,CAAoC;IAC7D,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,iBAAiB,CAAqC;IAC9D,OAAO,CAAC,yBAAyB,CAAiD;IAElF,mDAAmD;IACnD,OAAO,CAAC,gBAAgB,CAA6C;gBAElD,KAAK,EAAE,8BAA8B;IAQjD,OAAO;IAMd;;OAEG;IACI,oBAAoB,WAAkB,gBAAgB,mBAmB3D;IAEF;;;OAGG;IACH,OAAO,CAAC,yBAAyB,CAyB/B;IAEF,OAAO,CAAC,sBAAsB;IAO9B;;;;;;OAMG;IACU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCvG;;;;;;OAMG;IACU,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6C1G;;;;;OAKG;IACU,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC3F;;;;;;OAMG;IACI,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO;IAW3F;;;;;;OAMG;IACI,UAAU,WAAY,gBAAgB,UAAU,KAAK,EAAE,KAAG,KAAK,EAAE,CAmBtE;IAEF,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB,CAiC5B;IAEF;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,GAAG,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE;CAiH/H;AAgDD,gBAAgB;AAChB,eAAO,MAAM,aAAa,UAAW,KAAK,KAAG,IAAI,gBAAgB,CAShE,CAAC;AA+BF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,KAAK,KAAG,2BAA2B,EAwB/E,CAAC"}
+{"version":3,"file":"FavoritePropertiesManager.d.ts","sourceRoot":"","sources":["../../../../src/presentation-frontend/favorite-properties/FavoritePropertiesManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAiB,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,KAAK,EAAuC,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEzE;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,IAAA;IACN,KAAK,IAAA;IACL,MAAM,IAAA;CACP;AAED;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,OAAO,EAAE,0BAA0B,CAAC;CACrC;AAED;;;;;GAKG;AACH,qBAAa,yBAA0B,YAAW,WAAW;IAC3D;;;OAGG;IACH,OAAc,2BAA2B,SAAM;IAE/C,2DAA2D;IACpD,kBAAkB,gBAAqB,IAAI,EAAI;IAEtD,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,iBAAiB,CAAoC;IAC7D,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,iBAAiB,CAAqC;IAC9D,OAAO,CAAC,yBAAyB,CAAiD;IAElF,mDAAmD;IACnD,OAAO,CAAC,gBAAgB,CAA6C;gBAElD,KAAK,EAAE,8BAA8B;IAQjD,OAAO;IAMd;;OAEG;IACI,oBAAoB,WAAkB,gBAAgB,mBAmB3D;IAEF;;;OAGG;IACH,OAAO,CAAC,yBAAyB,CAyB/B;IAEF,OAAO,CAAC,sBAAsB;IAO9B;;;;;;OAMG;IACU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCvG;;;;;;OAMG;IACU,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6C1G;;;;;OAKG;IACU,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC3F;;;;;;OAMG;IACI,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO;IAW3F;;;;;;OAMG;IACI,UAAU,WAAY,gBAAgB,UAAU,KAAK,EAAE,KAAG,KAAK,EAAE,CAmBtE;IAEF,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB,CAmC5B;IAEF;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,GAAG,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE;CAiH/H;AAgDD,gBAAgB;AAChB,eAAO,MAAM,aAAa,UAAW,KAAK,KAAG,IAAI,gBAAgB,CAShE,CAAC;AA+BF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,KAAK,KAAG,2BAA2B,EAwB/E,CAAC"}