@memberjunction/core 0.9.0

package/dist/generic/interfaces.d.ts

@@ -0,0 +1,235 @@
+import { BaseEntity } from "./baseEntity";
+import { EntityInfo, RecordChange } from "./entityInfo";
+import { ApplicationInfo } from "./applicationInfo";
+import { RunViewParams } from "../views/runView";
+import { AuditLogTypeInfo, AuthorizationInfo, RoleInfo, RowLevelSecurityFilterInfo, UserInfo } from "./securityInfo";
+import { TransactionGroupBase } from "./transactionGroup";
+import { RunReportParams } from "./runReport";
+export declare class ProviderConfigDataBase {
+    private _includeSchemas;
+    private _excludeSchemas;
+    private _MJCoreSchemaName;
+    private _data;
+    get Data(): any;
+    get IncludeSchemas(): string[];
+    get MJCoreSchemaName(): string;
+    get ExcludeSchemas(): string[];
+    constructor(data: any, MJCoreScemaName?: string, includeSchemas?: string[], excludeSchemas?: string[]);
+}
+export declare class MetadataInfo {
+    ID: number;
+    Type: string;
+    UpdatedAt: Date;
+}
+export declare enum EntityDataProviderType {
+    Database = 1,
+    Network = 2
+}
+export interface IEntityDataProvider {
+    Config(configData: ProviderConfigDataBase): Promise<boolean>;
+    Load(entity: BaseEntity, RecordID: number, EntityRelationshipsToLoad: string[], user: UserInfo): Promise<{}>;
+    Save(entity: BaseEntity, user: UserInfo, options: EntitySaveOptions): Promise<{}>;
+    Delete(entity: BaseEntity, user: UserInfo): Promise<boolean>;
+    GetRecordChanges(entityName: string, recordId: number): Promise<RecordChange[]>;
+    get ProviderType(): EntityDataProviderType;
+}
+export declare class EntitySaveOptions {
+    IgnoreDirtyState: boolean;
+    SkipEntityAIActions?: boolean;
+}
+export declare class EntityRecordNameInput {
+    EntityName: string;
+    RecordID: number;
+}
+export declare class EntityRecordNameResult {
+    Success: boolean;
+    Status: string;
+    RecordID: number;
+    EntityName: string;
+    RecordName?: string;
+}
+export interface ILocalStorageProvider {
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+    remove(key: string): Promise<void>;
+}
+export interface IMetadataProvider {
+    Config(configData: ProviderConfigDataBase): Promise<boolean>;
+    get Entities(): EntityInfo[];
+    get Applications(): ApplicationInfo[];
+    get CurrentUser(): UserInfo;
+    get Roles(): RoleInfo[];
+    get RowLevelSecurityFilters(): RowLevelSecurityFilterInfo[];
+    get AuditLogTypes(): AuditLogTypeInfo[];
+    get Authorizations(): AuthorizationInfo[];
+    get LatestRemoteMetadata(): MetadataInfo[];
+    get LatestLocalMetadata(): MetadataInfo[];
+    LocalMetadataObsolete(type?: string): boolean;
+    GetEntityObject(entityName: string, contextUser: UserInfo): Promise<BaseEntity>;
+    /**
+     * Returns the Name of the specific recordId for a given entityName. This is done by
+     * looking for the IsNameField within the EntityFields collection for a given entity.
+     * If no IsNameField is found, but a field called "Name" exists, that value is returned. Otherwise null returned
+     * @param entityName
+     * @param recordId
+     * @returns the name of the record
+     */
+    GetEntityRecordName(entityName: string, recordId: number): Promise<string>;
+    /**
+     * Returns one or more record names using the same logic as GetEntityRecordName, but for multiple records at once - more efficient to use this method if you need to get multiple record names at once
+     * @param info
+     * @returns an array of EntityRecordNameResult objects
+     */
+    GetEntityRecordNames(info: EntityRecordNameInput[]): Promise<EntityRecordNameResult[]>;
+    GetRecordFavoriteStatus(userId: number, entityName: string, recordId: number): Promise<boolean>;
+    SetRecordFavoriteStatus(userId: number, entityName: string, recordId: number, isFavorite: boolean, contextUser: UserInfo): Promise<void>;
+    CreateTransactionGroup(): Promise<TransactionGroupBase>;
+    Refresh(): Promise<boolean>;
+    RefreshIfNeeded(): Promise<boolean>;
+    IsRefreshNeeded(): Promise<boolean>;
+    get LocalStorageProvider(): ILocalStorageProvider;
+    RefreshRemoteMetadataTimestamps(): Promise<boolean>;
+    SaveLocalMetadataToStorage(): Promise<void>;
+    /**
+     * 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
+     */
+    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
+     */
+    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.
+     * @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;
+    /**
+     * 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>;
+}
+/**
+ * Result of a RunView() execution
+ */
+export type RunViewResult = {
+    /**
+     * Was the view run successful or not
+     */
+    Success: boolean;
+    /**
+     * The array of records returned by the view, only valid if Success is true
+     */
+    Results: [];
+    /**
+     * The newly created UserViews.ID value - only provided if RunViewParams.SaveViewResults=true
+     */
+    UserViewRunID?: number;
+    /**
+     * Number of rows returned in the Results[] array
+     */
+    RowCount: number;
+    /**
+     * Total number of rows that match the view criteria, not just the number returned in the Results[] array
+     * This number will only be different when the view is configured to have a UserViewMaxRows value and the criteria of the view in question
+     * has more than that # of rows. Otherwise it will be the same value as RowCount.
+     */
+    TotalRowCount: number;
+    /**
+     * Time elapsed in executing the view (in milliseconds)
+     */
+    ExecutionTime: number;
+    /**
+     * If Success is false, this will contain a message describing the error condition.
+     */
+    ErrorMessage: string;
+};
+export interface IRunViewProvider {
+    Config(configData: ProviderConfigDataBase): Promise<boolean>;
+    RunView(params: RunViewParams, contextUser?: UserInfo): Promise<RunViewResult>;
+}
+export type RunReportResult = {
+    ReportID: number;
+    Success: boolean;
+    Results: any[];
+    RowCount: number;
+    ExecutionTime: number;
+    ErrorMessage: string;
+};
+export interface IRunReportProvider {
+    Config(configData: ProviderConfigDataBase): Promise<boolean>;
+    RunReport(params: RunReportParams, contextUser?: UserInfo): Promise<RunReportResult>;
+}
+export type DatasetResultType = {
+    DatasetID: number;
+    DatasetName: string;
+    Success: boolean;
+    Status: string;
+    LatestUpdateDate: Date;
+    Results: DatasetItemResultType[];
+};
+export type DatasetItemResultType = {
+    Code: string;
+    EntityName: string;
+    EntityID: number;
+    Results: any[];
+};
+export type DatasetItemFilterType = {
+    ItemCode: string;
+    Filter: string;
+};
+export type DatasetStatusResultType = {
+    DatasetID: number;
+    DatasetName: string;
+    Success: boolean;
+    Status: string;
+    LatestUpdateDate: Date;
+    EntityUpdateDates: DatasetStatusEntityUpdateDateType[];
+};
+export type DatasetStatusEntityUpdateDateType = {
+    EntityName: string;
+    EntityID: number;
+    UpdateDate: Date;
+};

package/dist/generic/interfaces.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityRecordNameResult = exports.EntityRecordNameInput = exports.EntitySaveOptions = exports.EntityDataProviderType = exports.MetadataInfo = exports.ProviderConfigDataBase = void 0;
+class ProviderConfigDataBase {
+    get Data() {
+        return this._data;
+    }
+    get IncludeSchemas() {
+        return this._includeSchemas;
+    }
+    get MJCoreSchemaName() {
+        return this._MJCoreSchemaName;
+    }
+    get ExcludeSchemas() {
+        return this._excludeSchemas;
+    }
+    constructor(data, MJCoreScemaName = 'admin', includeSchemas, excludeSchemas) {
+        this._includeSchemas = [];
+        this._excludeSchemas = [];
+        this._MJCoreSchemaName = 'admin';
+        this._data = data;
+        this._MJCoreSchemaName = MJCoreScemaName;
+        if (includeSchemas)
+            this._includeSchemas = includeSchemas;
+        if (excludeSchemas)
+            this._excludeSchemas = excludeSchemas;
+    }
+}
+exports.ProviderConfigDataBase = ProviderConfigDataBase;
+class MetadataInfo {
+}
+exports.MetadataInfo = MetadataInfo;
+var EntityDataProviderType;
+(function (EntityDataProviderType) {
+    EntityDataProviderType[EntityDataProviderType["Database"] = 1] = "Database";
+    EntityDataProviderType[EntityDataProviderType["Network"] = 2] = "Network";
+})(EntityDataProviderType = exports.EntityDataProviderType || (exports.EntityDataProviderType = {}));
+class EntitySaveOptions {
+    constructor() {
+        this.IgnoreDirtyState = false;
+        this.SkipEntityAIActions = false;
+    }
+}
+exports.EntitySaveOptions = EntitySaveOptions;
+class EntityRecordNameInput {
+}
+exports.EntityRecordNameInput = EntityRecordNameInput;
+class EntityRecordNameResult {
+}
+exports.EntityRecordNameResult = EntityRecordNameResult;
+//# sourceMappingURL=interfaces.js.map

package/dist/generic/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/generic/interfaces.ts"],"names":[],"mappings":";;;AAQA,MAAa,sBAAsB;IAK/B,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,gBAAgB;QACvB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IACD,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,YAAY,IAAS,EAAE,kBAA0B,OAAO,EAAE,cAAyB,EAAE,cAAyB;QAhBtG,oBAAe,GAAa,EAAE,CAAC;QAC/B,oBAAe,GAAa,EAAE,CAAC;QAC/B,sBAAiB,GAAW,OAAO,CAAC;QAexC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,iBAAiB,GAAG,eAAe,CAAC;QACzC,IAAI,cAAc;YACd,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QAC1C,IAAI,cAAc;YACd,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IAC9C,CAAC;CACJ;AAzBD,wDAyBC;AAED,MAAa,YAAY;CAIxB;AAJD,oCAIC;AAED,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAC9B,2EAAY,CAAA;IACZ,yEAAW,CAAA;AACf,CAAC,EAHW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAGjC;AAeD,MAAa,iBAAiB;IAA9B;QACI,qBAAgB,GAAY,KAAK,CAAC;QAClC,wBAAmB,GAAa,KAAK,CAAC;IAC1C,CAAC;CAAA;AAHD,8CAGC;AAED,MAAa,qBAAqB;CAGjC;AAHD,sDAGC;AAED,MAAa,sBAAsB;CAMjC;AANF,wDAME"}

package/dist/generic/logging.d.ts

@@ -0,0 +1,4 @@
+export declare function LogError(message: any, logToFileName?: string, ...args: any[]): void;
+export declare function LogStatus(message: any, logToFileName?: string, ...args: any[]): void;
+export declare function GetProductionStatus(): boolean;
+export declare function SetProductionStatus(isProduction: boolean): void;

package/dist/generic/logging.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetProductionStatus = exports.GetProductionStatus = exports.LogStatus = exports.LogError = void 0;
+let fs;
+if (runningOnNode()) {
+    try {
+        fs = require('fs');
+    }
+    catch (err) {
+        // shouldn't get here since we're checking for the node variables above, but have this 
+        // try/catch block just in case. 
+        // fs module is not available, normal in browser situation, we can't log to "Files" as that doesn't make sense in browser
+    }
+}
+function LogError(message, logToFileName = null, ...args) {
+    if (logToFileName !== null && logToFileName !== undefined && logToFileName.length >= 0)
+        logToFile(message, true, logToFileName, args);
+    else
+        logToConsole(message, true, args);
+}
+exports.LogError = LogError;
+function LogStatus(message, logToFileName = null, ...args) {
+    if (logToFileName !== null && logToFileName !== undefined && logToFileName.length >= 0)
+        logToFile(message, false, logToFileName, args);
+    else
+        logToConsole(message, false, args);
+}
+exports.LogStatus = LogStatus;
+function logToConsole(message, isError, ...args) {
+    if (isError) // always do console.error() for errors even in production
+        console.error(message, ...args);
+    else if (!GetProductionStatus()) // only do console.log() if we're not in production
+        console.log(message, ...args);
+}
+function logToFile(message, isError, logToFileName, ...args) {
+    if (fs === null || fs === undefined) {
+        console.error('Attempting to log to file, but fs module is not available, logging to console instead');
+        logToConsole(message, isError, args);
+    }
+    else
+        fs.appendFileSync(logToFileName, `${isError ? 'ERROR' : 'STATUS'} (${new Date()}: ${message}${args && args.length > 0 && args.join('').length > 0 ? '\n   ARGS' + args.join('\n   ') : ''}` + '\n');
+}
+let _productionStatus = null;
+function GetProductionStatus() {
+    if (_productionStatus)
+        return _productionStatus;
+    else {
+        if (runningOnNode()) {
+            return (process.env.NODE_ENV === 'production');
+        }
+        else if (runningInBrowser()) {
+            // no status set if we get here, so return false, default to false to be safe and log stuff
+            // for debug scenarios on staging environments/etc.
+            return false;
+        }
+    }
+}
+exports.GetProductionStatus = GetProductionStatus;
+function SetProductionStatus(isProduction) {
+    _productionStatus = isProduction;
+}
+exports.SetProductionStatus = SetProductionStatus;
+function runningInBrowser() {
+    return (typeof window !== 'undefined' && window.location !== null);
+}
+function runningOnNode() {
+    return (typeof process !== 'undefined' && process.versions !== null && process.versions.node !== null);
+}
+//# sourceMappingURL=logging.js.map

package/dist/generic/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../src/generic/logging.ts"],"names":[],"mappings":";;;AAAA,IAAI,EAAO,CAAC;AAEZ,IAAI,aAAa,EAAE,EAAE;IACjB,IAAI;QACA,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACtB;IAAC,OAAO,GAAG,EAAE;QACV,uFAAuF;QACvF,iCAAiC;QACjC,yHAAyH;KAC5H;CACJ;AAED,SAAgB,QAAQ,CAAC,OAAY,EAAE,gBAAwB,IAAI,EAAE,GAAG,IAAW;IAC/E,IAAI,aAAa,KAAK,IAAI,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC;QAClF,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,CAAA;;QAE7C,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;AACzC,CAAC;AALD,4BAKC;AAED,SAAgB,SAAS,CAAC,OAAY,EAAE,gBAAwB,IAAI,EAAE,GAAG,IAAW;IAChF,IAAI,aAAa,KAAK,IAAI,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC;QAClF,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,CAAA;;QAE9C,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;AAC1C,CAAC;AALD,8BAKC;AAED,SAAS,YAAY,CAAC,OAAY,EAAE,OAAgB,EAAE,GAAG,IAAW;IAChE,IAAI,OAAO,EAAE,0DAA0D;QACnE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;SAC/B,IAAI,CAAC,mBAAmB,EAAE,EAAE,mDAAmD;QAChF,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACtC,CAAC;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,OAAgB,EAAE,aAAqB,EAAE,GAAG,IAAW;IAC/E,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,SAAS,EAAE;QACjC,OAAO,CAAC,KAAK,CAAC,uFAAuF,CAAC,CAAC;QACvG,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;KACxC;;QAEG,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,IAAI,EAAE,KAAK,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAE,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;AAC7M,CAAC;AAED,IAAI,iBAAiB,GAAY,IAAI,CAAC;AACtC,SAAgB,mBAAmB;IAC/B,IAAI,iBAAiB;QACjB,OAAO,iBAAiB,CAAC;SACxB;QACD,IAAI,aAAa,EAAE,EAAE;YACjB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAA;SACjD;aACI,IAAI,gBAAgB,EAAE,EAAE;YACzB,2FAA2F;YAC3F,mDAAmD;YACnD,OAAO,KAAK,CAAC;SAChB;KACJ;AACL,CAAC;AAbD,kDAaC;AAED,SAAgB,mBAAmB,CAAC,YAAqB;IACrD,iBAAiB,GAAG,YAAY,CAAC;AACrC,CAAC;AAFD,kDAEC;AAED,SAAS,gBAAgB;IACrB,OAAO,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAA;AACtE,CAAC;AAED,SAAS,aAAa;IAClB,OAAO,CAAC,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AAC1G,CAAC"}

package/dist/generic/metadata.d.ts

@@ -0,0 +1,155 @@
+import { DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, IMetadataProvider } from "./interfaces";
+import { EntityInfo } from "./entityInfo";
+import { ApplicationInfo } from "./applicationInfo";
+import { BaseEntity } from "./baseEntity";
+import { AuditLogTypeInfo, AuthorizationInfo, RoleInfo, UserInfo } from "./securityInfo";
+import { TransactionGroupBase } from "./transactionGroup";
+/**
+ * Class used to access a wide array of MemberJunction metadata, to instantiate derived classes of BaseEntity for record access and manipulation and more. This class uses a provider model where different providers transparently plug-in to implement the functionality needed based on where the code is running. The provider in use is generally not of any importance to users of the class and code can be written indepdenent of tier/provider.
+ */
+export declare class Metadata {
+    private static _globalProviderKey;
+    static get Provider(): IMetadataProvider;
+    static set Provider(value: IMetadataProvider);
+    /**
+     * Forces a refresh of all cached metadata.
+     * @returns
+     */
+    Refresh(): Promise<boolean>;
+    get Applications(): ApplicationInfo[];
+    get Entities(): EntityInfo[];
+    /**
+     * Returns the current user, if known. In some execution environments, mainly on server tiers like in a node.js environment, there won't be a "current user" known to Metadata since the Metadata instance is shared across all requests. In this situation you should determine the current user from the server context where you get the user payload and find the user from the UserCache.
+     */
+    get CurrentUser(): UserInfo;
+    get Roles(): RoleInfo[];
+    get AuditLogTypes(): AuditLogTypeInfo[];
+    get Authorizations(): AuthorizationInfo[];
+    /**
+     * Helper function to return an Entity Name from a given Entity ID.
+     * @param entityName
+     * @returns
+     */
+    EntityIDFromName(entityName: string): number;
+    /**
+     * Helper function to return an Entity Name from an Entity ID
+     * @param entityID
+     * @returns
+     */
+    EntityNameFromID(entityID: number): string;
+    /**
+     * Returns true if the combination of userId/entityName/recordId has a favorite status on (meaning the user has marked the record as a "favorite" for easy access)
+     * @param userId
+     * @param entityName
+     * @param recordId
+     * @returns
+     */
+    GetRecordFavoriteStatus(userId: number, entityName: string, recordId: number): Promise<boolean>;
+    /**
+     * Sets the favorite status for a given user for a specific entityName/recordId
+     * @param userId
+     * @param entityName
+     * @param recordId
+     * @param isFavorite
+     * @param contextUser
+     */
+    SetRecordFavoriteStatus(userId: number, entityName: string, recordId: number, isFavorite: boolean, contextUser?: UserInfo): Promise<void>;
+    /**
+     * Returns a newly created instance of a sub-class of BaseEntity. The subclass depends on the class registrations for the
+     * requested entity. The class registrations are managed by the MJGlobal ClassFactory component.
+     * @param entityName - The name of the entity to create an instance of
+     * @param contextUser - The user to use for context. If null, the current user is used. This is mainly used on the server side, for browser based applications generally the context will be known
+     * @returns - a newly created instance of a sub-class of BaseEntity. Remember you still to call Load() or NewRecord() to get going from there.
+     */
+    GetEntityObject(entityName: string, contextUser?: UserInfo): Promise<BaseEntity>;
+    /**
+     * Returns the Name of the specific recordId for a given entityName. This is done by
+     * looking for the IsNameField within the EntityFields collection for a given entity.
+     * If no IsNameField is found, but a field called "Name" exists, that value is returned. Otherwise null returned
+     * @param entityName
+     * @param recordId
+     * @returns the name of the record
+     */
+    GetEntityRecordName(entityName: string, recordId: number): Promise<string>;
+    /**
+     * Returns one or more record names using the same logic as GetEntityRecordName, but for multiple records at once - more efficient to use this method if you need to get multiple record names at once
+     * @param info
+     * @returns an array of EntityRecordNameResult objects
+     */
+    GetEntityRecordNames(info: EntityRecordNameInput[]): Promise<EntityRecordNameResult[]>;
+    /**
+     * Creates a new TransactionGroup which can be used to bundle multiple database changes for BaseEntity derived classes to be processed as a single database transaction
+     * @returns
+     */
+    CreateTransactionGroup(): Promise<TransactionGroupBase>;
+    /**
+     * Saves all the in-memory metadata to be updated in the local persistent storage method (which varies by provider). This generally shouldn't need to be called externally but is available to force an update to local storage as desired.
+     */
+    SaveLocalMetadataToStorage(): void;
+    /**
+     * Returns the local storage provider. This is used to store metadata locally on the client.
+     * @returns - the local storage provider
+     * @remarks - Use this for storing any type of data on the client. The Provider implements the storage mechanism which is persistent whenever possible, but in some cases purely in memory if local persistence is not available. Keep in mind that you must ensure that keys are unique so prefix all of your keys with something unique to avoid collisions.
+     */
+    get LocalStorageProvider(): ILocalStorageProvider;
+    /**
+     * 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
+     */
+    GetDatasetStatusByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetStatusResultType>;
+    /**
+     * 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
+     */
+    GetDatasetByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetResultType>;
+    /**
+     * 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.
+     * @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;
+    /**
+     * 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>;
+}