@memberjunction/core 0.9.166 → 0.9.167

package/dist/MJCore/src/generic/providerBase.d.ts

@@ -1,183 +0,0 @@
-import { BaseEntity } from "./baseEntity";
-import { EntityDependency, EntityInfo, PrimaryKeyValue, RecordDependency, RecordMergeRequest, RecordMergeResult } from "./entityInfo";
-import { IMetadataProvider, ProviderConfigDataBase, MetadataInfo, ILocalStorageProvider, DatasetResultType, DatasetStatusResultType, DatasetItemFilterType, EntityRecordNameInput, EntityRecordNameResult, ProviderType } from "./interfaces";
-import { ApplicationInfo } from "../generic/applicationInfo";
-import { AuditLogTypeInfo, AuthorizationInfo, RoleInfo, RowLevelSecurityFilterInfo, UserInfo } from "./securityInfo";
-import { TransactionGroupBase } from "./transactionGroup";
-import { QueryCategoryInfo, QueryFieldInfo, QueryInfo, QueryPermissionInfo } from "./queryInfo";
-export type AllMetadata = {
-    AllEntities: EntityInfo[];
-    AllApplications: ApplicationInfo[];
-    CurrentUser: UserInfo;
-    AllRoles: RoleInfo[];
-    AllRowLevelSecurityFilters: RowLevelSecurityFilterInfo[];
-    AllAuditLogTypes: AuditLogTypeInfo[];
-    AllAuthorizations: AuthorizationInfo[];
-    AllQueryCategories: QueryCategoryInfo[];
-    AllQueries: QueryInfo[];
-    AllQueryFields: QueryFieldInfo[];
-    AllQueryPermissions: QueryPermissionInfo[];
-};
-export declare abstract class ProviderBase implements IMetadataProvider {
-    private _ConfigData;
-    private _latestLocalMetadataTimestamps;
-    private _latestRemoteMetadataTimestamps;
-    private _entities;
-    private _applications;
-    private _currentUser;
-    private _roles;
-    private _rowLevelSecurityFilters;
-    private _auditLogTypes;
-    private _authorizations;
-    private _queries;
-    private _queryCategories;
-    private _queryFields;
-    private _queryPermissions;
-    private _refresh;
-    /******** ABSTRACT SECTION ****************************************************************** */
-    protected abstract AllowRefresh(): boolean;
-    abstract get ProviderType(): ProviderType;
-    abstract GetEntityRecordName(entityName: string, primaryKeyValues: PrimaryKeyValue[]): Promise<string>;
-    abstract GetEntityRecordNames(info: EntityRecordNameInput[]): Promise<EntityRecordNameResult[]>;
-    abstract GetRecordFavoriteStatus(userId: number, entityName: string, primaryKeyValues: PrimaryKeyValue[]): Promise<boolean>;
-    abstract SetRecordFavoriteStatus(userId: number, entityName: string, primaryKeyValues: PrimaryKeyValue[], isFavorite: boolean, contextUser: UserInfo): Promise<void>;
-    /******** END - ABSTRACT SECTION ****************************************************************** */
-    Config(data: ProviderConfigDataBase): Promise<boolean>;
-    protected BuildDatasetFilterFromConfig(): DatasetItemFilterType[];
-    protected static _mjMetadataDatasetName: string;
-    protected GetAllMetadata(): Promise<AllMetadata>;
-    protected abstract GetCurrentUser(): Promise<UserInfo>;
-    protected PostProcessEntityMetadata(entities: any[], fields: any[], fieldValues: any[], permissions: any[], relationships: any[]): any[];
-    get ConfigData(): ProviderConfigDataBase;
-    get Entities(): EntityInfo[];
-    get Applications(): ApplicationInfo[];
-    get CurrentUser(): UserInfo;
-    get Roles(): RoleInfo[];
-    get RowLevelSecurityFilters(): RowLevelSecurityFilterInfo[];
-    get AuditLogTypes(): AuditLogTypeInfo[];
-    get Authorizations(): AuthorizationInfo[];
-    get Queries(): QueryInfo[];
-    get QueryCategories(): QueryCategoryInfo[];
-    get QueryFields(): QueryFieldInfo[];
-    get QueryPermissions(): QueryPermissionInfo[];
-    Refresh(): Promise<boolean>;
-    IsRefreshNeeded(): Promise<boolean>;
-    RefreshIfNeeded(): Promise<boolean>;
-    GetEntityObject<T extends BaseEntity>(entityName: string, contextUser?: UserInfo): Promise<T>;
-    /**
-     * Returns a list of dependencies - records that are linked to the specified Entity/RecordID combination. A dependency is as defined by the relationships in the database. The MemberJunction metadata that is used
-     * for this simply reflects the foreign key relationships that exist in the database. The CodeGen tool is what detects all of the relationships and generates the metadata that is used by MemberJunction. The metadata in question
-     * is within the EntityField table and specifically the RelatedEntity and RelatedEntityField columns. In turn, this method uses that metadata and queries the database to determine the dependencies. To get the list of entity dependencies
-     * you can use the utility method GetEntityDependencies(), which doesn't check for dependencies on a specific record, but rather gets the metadata in one shot that can be used for dependency checking.
-     * @param entityName the name of the entity to check
-     * @param primaryKeyValues the values of the primary key of the record to check
-     */
-    abstract GetRecordDependencies(entityName: string, primaryKeyValues: PrimaryKeyValue[]): Promise<RecordDependency[]>;
-    /**
-     * Returns a list of entity dependencies, basically metadata that tells you the links to this entity from all other entities.
-     * @param entityName
-     * @returns
-     */
-    GetEntityDependencies(entityName: string): Promise<EntityDependency[]>;
-    /**
-     * This method will merge two or more records based on the request provided. The RecordMergeRequest type you pass in specifies the record that will survive the merge, the records to merge into the surviving record, and an optional field map that can update values in the surviving record, if desired. The process followed is:
-     * 1. A transaction is started
-     * 2. The surviving record is loaded and fields are updated from the field map, if provided, and the record is saved. If a FieldMap not provided within the request object, this step is skipped.
-     * 3. For each of the records that will be merged INTO the surviving record, we call the GetEntityDependencies() method and get a list of all other records in the database are linked to the record to be deleted. We then go through each of those dependencies and update the link to point to the SurvivingRecordID and save the record.
-     * 4. The record to be deleted is then deleted.
-     * 5. The transaction is committed if all of the above steps are succesful, otherwise it is rolled back.
-     *
-     * The return value from this method contains detailed information about the execution of the process. In addition, all attempted merges are logged in the RecordMergeLog and RecordMergeDeletionLog tables.
-     *
-     * @param request
-     * @returns
-     */
-    abstract MergeRecords(request: RecordMergeRequest): Promise<RecordMergeResult>;
-    /**
-     * Always retrieves data from the server - this method does NOT check cache. To use cached local values if available, call GetAndCacheDatasetByName() instead
-     * @param datasetName
-     * @param itemFilters
-     */
-    abstract GetDatasetByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetResultType>;
-    /**
-     * Retrieves the date status information for a dataset and all its items from the server. This method will match the datasetName and itemFilters to the server's dataset and item filters to determine a match
-     * @param datasetName
-     * @param itemFilters
-     */
-    abstract GetDatasetStatusByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetStatusResultType>;
-    /**
-     * Gets a database by name, if required, and caches it in a format available to the client (e.g. IndexedDB, LocalStorage, File, etc). The cache method is Provider specific
-     * If itemFilters are provided, the combination of datasetName and the filters are used to determine a match in the cache
-     * @param datasetName
-     * @param itemFilters
-     */
-    GetAndCacheDatasetByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetResultType>;
-    /**
-     * This routine checks to see if the local cache version of a given datasetName/itemFilters combination is up to date with the server or not
-     * @param datasetName
-     * @param itemFilters
-     * @returns
-     */
-    IsDatasetCacheUpToDate(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<boolean>;
-    /**
-     * This routine gets the local cached version of a given datasetName/itemFilters combination, it does NOT check the server status first and does not fall back on the server if there isn't a local cache version of this dataset/itemFilters combination
-     * @param datasetName
-     * @param itemFilters
-     * @returns
-     */
-    GetCachedDataset(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetResultType>;
-    /**
-     * Stores a dataset in the local cache. If itemFilters are provided, the combination of datasetName and the filters are used to build a key and determine a match in the cache
-     * @param datasetName
-     * @param itemFilters
-     * @param dataset
-     */
-    CacheDataset(datasetName: string, itemFilters: DatasetItemFilterType[], dataset: DatasetResultType): Promise<void>;
-    /**
-     * Determines if a given datasetName/itemFilters combination is cached locally or not
-     * @param datasetName
-     * @param itemFilters
-     * @returns
-     */
-    IsDatasetCached(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<boolean>;
-    /**
-     * Creates a key for the given datasetName and itemFilters combination
-     * @param datasetName
-     * @param itemFilters
-     * @returns
-     */
-    GetDatasetCacheKey(datasetName: string, itemFilters?: DatasetItemFilterType[]): string;
-    protected ConvertItemFiltersToUniqueKey(itemFilters: DatasetItemFilterType[]): string;
-    /**
-     * If the specified datasetName is cached, this method will clear the cache. If itemFilters are provided, the combination of datasetName and the filters are used to determine a match in the cache
-     * @param datasetName
-     * @param itemFilters
-     */
-    ClearDatasetCache(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<void>;
-    abstract CreateTransactionGroup(): Promise<TransactionGroupBase>;
-    get LatestRemoteMetadata(): MetadataInfo[];
-    get LatestLocalMetadata(): MetadataInfo[];
-    protected GetLatestMetadataUpdates(): Promise<MetadataInfo[]>;
-    RefreshRemoteMetadataTimestamps(): Promise<boolean>;
-    LocalMetadataObsolete(type?: string): boolean;
-    protected UpdateLocalMetadata(res: AllMetadata): void;
-    abstract get LocalStorageProvider(): ILocalStorageProvider;
-    protected LoadLocalMetadataFromStorage(): Promise<void>;
-    private static localStorageRootKey;
-    private static localStorageTimestampsKey;
-    private static localStorageEntitiesKey;
-    private static localStorageApplicationsKey;
-    private static localStorageCurrentUserKey;
-    private static localStorageRolesKey;
-    private static localStorageRowLevelSecurityFiltersKey;
-    private static localStorageAuditLogTypesKey;
-    private static localStorageAuthorizationsKey;
-    private static localStorageQueriesKey;
-    private static localStorageQueryCategoriesKey;
-    private static localStorageQueryFieldsKey;
-    private static localStorageQueryPermissionsKey;
-    private static localStorageKeys;
-    SaveLocalMetadataToStorage(): Promise<void>;
-    RemoveLocalMetadataFromStorage(): Promise<void>;
-    protected abstract get Metadata(): IMetadataProvider;
-}