@memberjunction/global 2.111.0 → 2.112.0

package/dist/generic/metadata.js

@@ -0,0 +1,454 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metadata = void 0;
+const securityInfo_1 = require("./securityInfo");
+const logging_1 = require("./logging");
+const compositeKey_1 = require("./compositeKey");
+const runView_1 = require("../views/runView");
+const Global_1 = require("../Global");
+/**
+ * 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.
+ */
+class Metadata {
+    /**
+     * When an application initializes, the Provider package that is being used for that application will handle setting the provider globally via this static property.
+     * This is done so that the provider can be accessed from anywhere in the application without having to pass it around. This pattern is used sparingly in MJ.
+     */
+    static get Provider() {
+        const g = Global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            return g[Metadata._globalProviderKey];
+        else
+            throw new Error('No global object store, so we cant get the static provider');
+    }
+    static set Provider(value) {
+        const g = Global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            g[Metadata._globalProviderKey] = value;
+        else
+            throw new Error('No global object store, so we cant set the static provider');
+    }
+    /**
+     * Forces a refresh of all cached metadata.
+     * @returns
+     */
+    async Refresh(providerToUse) {
+        return await Metadata.Provider.Refresh(providerToUse);
+    }
+    get ProviderType() {
+        return Metadata.Provider.ProviderType;
+    }
+    get Applications() {
+        return Metadata.Provider.Applications;
+    }
+    get Entities() {
+        return Metadata.Provider.Entities;
+    }
+    /**
+     * Helper method to find an entity by name in a case insensitive manner.
+     * @param entityName
+     */
+    EntityByName(entityName) {
+        if (!entityName || typeof entityName !== 'string' || entityName.trim().length === 0) {
+            throw new Error('EntityByName: entityName must be a non-empty string');
+        }
+        return this.Entities.find((e) => e.Name.toLowerCase().trim() === entityName.toLowerCase().trim());
+    }
+    /**
+     * Helper method to find an entity by ID
+     * @param entityID
+     * @returns
+     */
+    EntityByID(entityID) {
+        return this.Entities.find((e) => e.ID === entityID);
+    }
+    get Queries() {
+        return Metadata.Provider.Queries;
+    }
+    get QueryFields() {
+        return Metadata.Provider.QueryFields;
+    }
+    get QueryCategories() {
+        return Metadata.Provider.QueryCategories;
+    }
+    get QueryPermissions() {
+        return Metadata.Provider.QueryPermissions;
+    }
+    /**
+     * 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() {
+        return Metadata.Provider.CurrentUser;
+    }
+    get Roles() {
+        return Metadata.Provider.Roles;
+    }
+    get AuditLogTypes() {
+        return Metadata.Provider.AuditLogTypes;
+    }
+    get Authorizations() {
+        return Metadata.Provider.Authorizations;
+    }
+    get Libraries() {
+        return Metadata.Provider.Libraries;
+    }
+    /**
+     * Returns all of the ExplorerNavigationItems that are visible to the user, sorted by Sequence. Filtered by the IsActive bit.
+     */
+    get VisibleExplorerNavigationItems() {
+        return Metadata.Provider.VisibleExplorerNavigationItems;
+    }
+    /**
+     * Returns all of the ExplorerNavigationItems, including those that are not visible. This is useful for admin tools and other places where you need to see all of the navigation items, not just the ones that are visible to the user.
+     */
+    get AllExplorerNavigationItems() {
+        return Metadata.Provider.AllExplorerNavigationItems;
+    }
+    /**
+     * Helper function to return an Entity Name from a given Entity ID.
+     * @param entityName
+     * @returns
+     */
+    EntityIDFromName(entityName) {
+        let entity = this.Entities.find((e) => e.Name == entityName);
+        if (entity != null)
+            return entity.ID;
+        else
+            throw new Error(`Entity ${entityName} not found`);
+    }
+    /**
+     * Helper function to return an Entity Name from an Entity ID
+     * @param entityID
+     * @returns
+     */
+    EntityNameFromID(entityID) {
+        let entity = this.Entities.find((e) => e.ID == entityID);
+        if (entity) {
+            return entity.Name;
+        }
+        else {
+            (0, logging_1.LogError)(`Entity ID: ${entityID} not found`);
+            return null;
+        }
+    }
+    /**
+     * Helper function to return an EntityInfo from an Entity ID
+     * @param entityID
+     */
+    EntityFromEntityID(entityID) {
+        let entity = this.Entities.find((e) => e.ID == entityID);
+        if (entity) {
+            return entity;
+        }
+        else {
+            (0, logging_1.LogError)(`Entity ID: ${entityID} not found`);
+            return null;
+        }
+    }
+    /**
+     * Returns true if the combination of userId/entityName/KeyValuePairs has a favorite status on (meaning the user has marked the record as a "favorite" for easy access)
+     * @param userId
+     * @param entityName
+     * @param primaryKey
+     * @returns
+     */
+    async GetRecordFavoriteStatus(userId, entityName, primaryKey, contextUser) {
+        return await Metadata.Provider.GetRecordFavoriteStatus(userId, entityName, primaryKey, contextUser);
+    }
+    /**
+     * Returns an array of records representing the list of changes made to a record. This functionality only works
+     * if an entity has TrackRecordChanges = 1, which is the default for most entities. If TrackRecordChanges = 0, this method will return an empty array.
+     *
+     * This method is defined in the @memberjunction/global package, which is lower level in the dependency
+     * hierarchy than the @memberjunction/core-entities package where the RecordChangeEntity class is defined.
+     * For this reason, we are not using the RecordChangeEntity class here, but rather returning a generic type T.
+     * When you call this method, you can specify the type T to be the RecordChangeEntity class or any other class that matches the structure of the record changes.
+     * For example:
+     * ```typescript
+     * const md = new Metadata();
+     * const changes: RecordChangeEntity[] = await md.GetRecordChanges<RecordChangeEntity>('MyEntity', myPrimaryKey);
+     * ```
+     * @param entityName
+     * @param primaryKey
+     * @param contextUser
+     * @returns
+     */
+    async GetRecordChanges(entityName, primaryKey, contextUser) {
+        try {
+            const e = this.EntityByName(entityName);
+            if (!e) {
+                throw new Error(`Entity ${entityName} not found`);
+            }
+            if (!e.TrackRecordChanges) {
+                (0, logging_1.LogStatus)(`GetRecordChanges called for entity ${entityName} with primary key ${primaryKey.ToConcatenatedString()} but TrackRecordChanges is not enabled, returning empty array.`);
+                return []; // Return empty array if TrackRecordChanges is not enabled
+            }
+            const rv = new runView_1.RunView();
+            const result = await rv.RunView({
+                EntityName: 'Record Changes',
+                ExtraFilter: `Entity='${entityName}' AND RecordID='${primaryKey.ToConcatenatedString()}'`,
+                OrderBy: 'ChangedAt DESC',
+            }, contextUser);
+            if (result.Success) {
+                return result.Results;
+            }
+        }
+        catch (e) {
+            (0, logging_1.LogError)(`GetRecordChanges failed for entityName: ${entityName} and primaryKey: ${primaryKey}. Error: ${e.message}`);
+            throw e;
+        }
+    }
+    /**
+     * Sets the favorite status for a given user for a specific entityName/KeyValuePairs
+     * @param userId
+     * @param entityName
+     * @param primaryKey
+     * @param isFavorite
+     * @param contextUser
+     */
+    async SetRecordFavoriteStatus(userId, entityName, primaryKey, isFavorite, contextUser = null) {
+        await Metadata.Provider.SetRecordFavoriteStatus(userId, entityName, primaryKey, isFavorite, contextUser);
+    }
+    /**
+     * Returns a list of dependencies - records that are linked to the specified Entity/Primary Key Value 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 primaryKey the primary key value to check
+     */
+    async GetRecordDependencies(entityName, primaryKey) {
+        return await Metadata.Provider.GetRecordDependencies(entityName, primaryKey);
+    }
+    /**
+     * Returns a list of record IDs that are possible duplicates of the specified record.
+     *
+     * @param params object containing many properties used in fetching records and determining which ones to return
+     */
+    async GetRecordDuplicates(params, contextUser) {
+        return await Metadata.Provider.GetRecordDuplicates(params, contextUser);
+    }
+    /**
+     * Returns a list of entity dependencies, basically metadata that tells you the links to this entity from all other entities.
+     * @param entityName
+     * @returns
+     */
+    async GetEntityDependencies(entityName) {
+        return await Metadata.Provider.GetEntityDependencies(entityName);
+    }
+    /**
+     * 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. 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.
+     * 2. 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 SurvivingRecordKeyValuePair and save the record.
+     * 3. The record to be deleted is then deleted.
+     *
+     * 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.
+     *
+     * IMPORTANT NOTE: This functionality ASSUMES that you are calling BEGIN TRANS and COMMIT TRANS/ROLLBACK TRANS outside of the work being done inside if you are on the database server side (not on the client side). The reason is that many API servers that use this object infrastructure have transaction wrappers for each individual API request
+     * so we are not doing BEGIN/COMMIT/ROLLBACK within this functionality. If you are using this on the client side, you don't need to do anything extra, the server side, however, must wrap this with begin/commit/rollback statements to the database server.
+     * If you're using MJAPI/MJServer this is done for you automatically.
+     *
+     * @param request
+     * @returns
+     */
+    async MergeRecords(request, contextUser, options) {
+        const e = this.EntityByName(request.EntityName);
+        if (e.AllowRecordMerge)
+            return await Metadata.Provider.MergeRecords(request, contextUser, options);
+        else
+            throw new Error(`Entity ${request.EntityName} does not allow record merging, check the AllowRecordMerge property in the entity metadata`);
+    }
+    async GetEntityObject(entityName, loadKeyOrContextUser, contextUser) {
+        // validate that entityName is not null, undefined and IS a string > 0 length
+        if (!entityName || typeof entityName !== 'string' || entityName.trim().length === 0) {
+            throw new Error('GetEntityObject: entityName must be a non-empty string');
+        }
+        // Determine which overload was called
+        let actualLoadKey;
+        let actualContextUser;
+        if (loadKeyOrContextUser instanceof compositeKey_1.CompositeKey) {
+            // Second overload: entityName, loadKey, contextUser
+            actualLoadKey = loadKeyOrContextUser;
+            actualContextUser = contextUser;
+        }
+        else if (contextUser !== undefined) {
+            // Second overload with null/undefined loadKey: entityName, null/undefined, contextUser
+            actualLoadKey = undefined;
+            actualContextUser = contextUser;
+        }
+        else {
+            // First overload: entityName, contextUser
+            actualContextUser = loadKeyOrContextUser;
+        }
+        // validate that contextUser is either null/undefined or a UserInfo object
+        if (actualContextUser) {
+            // contextUser has been specified. We need to make sure the shape of the object
+            // is correct to allow objects that are not true instances of UserInfo but have the
+            // same shape - e.g. duck typing
+            if (!(actualContextUser instanceof securityInfo_1.UserInfo)) {
+                const u = actualContextUser;
+                if (u && u.ID && u.Name && u.Email && u.UserRoles) {
+                    // we have a UserInfo-like object, so we can use it
+                    actualContextUser = new securityInfo_1.UserInfo(Metadata.Provider, u);
+                }
+                else {
+                    throw new Error('GetEntityObject: contextUser must be null/undefined, a UserInfo instance, or an object that has the same shape as UserInfo, notably having the following properties: ID, Name, Email, and UserRoles');
+                }
+            }
+        }
+        return await Metadata.Provider.GetEntityObject(entityName, actualLoadKey, actualContextUser);
+    }
+    /**
+     * Returns the Name of the specific KeyValuePairs 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 primaryKey
+     * @returns the name of the record
+     */
+    async GetEntityRecordName(entityName, primaryKey, contextUser) {
+        let result = primaryKey.Validate();
+        if (!result.IsValid) {
+            throw new Error(result.ErrorMessage);
+        }
+        return await Metadata.Provider.GetEntityRecordName(entityName, primaryKey, contextUser);
+    }
+    /**
+     * 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
+     */
+    async GetEntityRecordNames(info, contextUser) {
+        // valiate to make sure we don't have any null primary keys being sent in
+        for (let i = 0; i < info.length; i++) {
+            if (!info[i].CompositeKey.KeyValuePairs || info[i].CompositeKey.KeyValuePairs.length == 0) {
+                throw new Error('GetEntityRecordNames: KeyValuePairs cannot be null or empty. It is for item ' + i.toString() + ' in the input array.');
+            }
+            else {
+                // check each primary key value to make sure it's not null
+                for (let j = 0; j < info[i].CompositeKey.KeyValuePairs.length; j++) {
+                    if (!info[i].CompositeKey.KeyValuePairs[j] || !info[i].CompositeKey.KeyValuePairs[j].Value) {
+                        throw new Error('GetEntityRecordNames: KeyValuePairs cannot contain null values. FieldName: ' +
+                            info[i].CompositeKey.KeyValuePairs[j]?.FieldName);
+                    }
+                }
+            }
+        }
+        return await Metadata.Provider.GetEntityRecordNames(info, contextUser);
+    }
+    /**
+     * 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
+     */
+    async CreateTransactionGroup() {
+        return await Metadata.Provider.CreateTransactionGroup();
+    }
+    /**
+     * 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.
+     */
+    async SaveLocalMetadataToStorage() {
+        await Metadata.Provider.SaveLocalMetadataToStorage();
+    }
+    /**
+     * Removes all the metadata from the local persistent storage method (which varies by provider). This generally shouldn't need to be called externally but is available to force an complete removal of local metadata in storage.
+     * NOTE: this does not remove Datasets, for removing datasets, use ClearDatasetCache()
+     */
+    async RemoveLocalMetadataFromStorage() {
+        await Metadata.Provider.RemoveLocalMetadataFromStorage();
+    }
+    /**
+     * 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() {
+        return Metadata.Provider.LocalStorageProvider;
+    }
+    /**
+     * 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
+     */
+    async GetDatasetStatusByName(datasetName, itemFilters, contextUser, providerToUse) {
+        return Metadata.Provider.GetDatasetStatusByName(datasetName, itemFilters, contextUser, providerToUse);
+    }
+    /**
+     * 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
+     */
+    async GetDatasetByName(datasetName, itemFilters, contextUser, providerToUse) {
+        return Metadata.Provider.GetDatasetByName(datasetName, itemFilters, contextUser, providerToUse);
+    }
+    /**
+     * Gets a dataset 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
+     */
+    async GetAndCacheDatasetByName(datasetName, itemFilters, contextUser) {
+        return Metadata.Provider.GetAndCacheDatasetByName(datasetName, itemFilters, contextUser);
+    }
+    /**
+     * 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
+     */
+    async IsDatasetCacheUpToDate(datasetName, itemFilters) {
+        return Metadata.Provider.IsDatasetCacheUpToDate(datasetName, itemFilters);
+    }
+    /**
+     * 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
+     */
+    async GetCachedDataset(datasetName, itemFilters) {
+        return Metadata.Provider.GetCachedDataset(datasetName, itemFilters);
+    }
+    /**
+     * 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
+     */
+    async CacheDataset(datasetName, itemFilters, dataset) {
+        return Metadata.Provider.CacheDataset(datasetName, itemFilters, dataset);
+    }
+    /**
+     * Determines if a given datasetName/itemFilters combination is cached locally or not
+     * @param datasetName
+     * @param itemFilters
+     * @returns
+     */
+    async IsDatasetCached(datasetName, itemFilters) {
+        return Metadata.Provider.IsDatasetCached(datasetName, itemFilters);
+    }
+    /**
+     * Creates a key for the given datasetName and itemFilters combination
+     * @param datasetName
+     * @param itemFilters
+     * @returns
+     */
+    GetDatasetCacheKey(datasetName, itemFilters) {
+        return Metadata.Provider.GetDatasetCacheKey(datasetName, itemFilters);
+    }
+    /**
+     * 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
+     */
+    async ClearDatasetCache(datasetName, itemFilters) {
+        return Metadata.Provider.ClearDatasetCache(datasetName, itemFilters);
+    }
+    /**
+     * Provides access the configuration object that was initially provided to configure the provider
+     */
+    get ConfigData() {
+        return Metadata.Provider.ConfigData;
+    }
+}
+exports.Metadata = Metadata;
+Metadata._globalProviderKey = 'MJ_MetadataProvider';
+//# sourceMappingURL=metadata.js.map

package/dist/generic/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/generic/metadata.ts"],"names":[],"mappings":";;;AAiBA,iDAAyF;AAGzF,uCAAgD;AAEhD,iDAA8C;AAE9C,8CAA2C;AAC3C,sCAAqC;AAErC;;GAEG;AACH,MAAa,QAAQ;IAEnB;;;OAGG;IACI,MAAM,KAAK,QAAQ;QACxB,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;;YACxC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;IACM,MAAM,KAAK,QAAQ,CAAC,KAAwB;QACjD,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YAAE,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;;YACzC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,aAAiC;QACpD,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,UAAkB;QACpC,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpF,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IACpG,CAAC;IACD;;;;OAIG;IACI,UAAU,CAAC,QAAgB;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;IACvC,CAAC;IAED,IAAW,eAAe;QACxB,OAAO,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC3C,CAAC;IAED,IAAW,gBAAgB;QACzB,OAAO,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;IACvC,CAAC;IAED,IAAW,KAAK;QACd,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;IACjC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC;IACzC,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAW,8BAA8B;QACvC,OAAO,QAAQ,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,IAAW,0BAA0B;QACnC,OAAO,QAAQ,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,UAAkB;QACxC,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,UAAU,CAAC,CAAC;QAC7D,IAAI,MAAM,IAAI,IAAI;YAAE,OAAO,MAAM,CAAC,EAAE,CAAC;;YAChC,MAAM,IAAI,KAAK,CAAC,UAAU,UAAU,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAgB;QACtC,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;QACzD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,IAAA,kBAAQ,EAAC,cAAc,QAAQ,YAAY,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,QAAgB;QACxC,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;QACzD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,IAAA,kBAAQ,EAAC,cAAc,QAAQ,YAAY,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,uBAAuB,CAClC,MAAc,EACd,UAAkB,EAClB,UAAwB,EACxB,WAAsB;QAEtB,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,gBAAgB,CAAI,UAAkB,EAAE,UAAwB,EAAE,WAAsB;QACnG,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,CAAC,CAAC,EAAE,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,UAAU,UAAU,YAAY,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;gBAC1B,IAAA,mBAAS,EACP,sCAAsC,UAAU,qBAAqB,UAAU,CAAC,oBAAoB,EAAE,gEAAgE,CACvK,CAAC;gBACF,OAAO,EAAE,CAAC,CAAC,0DAA0D;YACvE,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,iBAAO,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAC7B;gBACE,UAAU,EAAE,gBAAgB;gBAC5B,WAAW,EAAE,WAAW,UAAU,mBAAmB,UAAU,CAAC,oBAAoB,EAAE,GAAG;gBACzF,OAAO,EAAE,gBAAgB;aAC1B,EACD,WAAW,CACZ,CAAC;YACF,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,MAAM,CAAC,OAAO,CAAC;YACxB,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAA,kBAAQ,EAAC,2CAA2C,UAAU,oBAAoB,UAAU,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACrH,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,uBAAuB,CAClC,MAAc,EACd,UAAkB,EAClB,UAAwB,EACxB,UAAmB,EACnB,cAAwB,IAAI;QAE5B,MAAM,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,qBAAqB,CAAC,UAAkB,EAAE,UAAwB;QAC7E,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,MAAiC,EAAE,WAAsB;QACxF,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAAC,UAAkB;QACnD,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,YAAY,CAAC,OAA2B,EAAE,WAAsB,EAAE,OAA4B;QACzG,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,CAAC,gBAAgB;YAAE,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;;YAEjG,MAAM,IAAI,KAAK,CACb,UAAU,OAAO,CAAC,UAAU,4FAA4F,CACzH,CAAC;IACN,CAAC;IAyDM,KAAK,CAAC,eAAe,CAC1B,UAAkB,EAClB,oBAA8C,EAC9C,WAAsB;QAEtB,6EAA6E;QAC7E,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpF,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,sCAAsC;QACtC,IAAI,aAAuC,CAAC;QAC5C,IAAI,iBAAuC,CAAC;QAE5C,IAAI,oBAAoB,YAAY,2BAAY,EAAE,CAAC;YACjD,oDAAoD;YACpD,aAAa,GAAG,oBAAoB,CAAC;YACrC,iBAAiB,GAAG,WAAW,CAAC;QAClC,CAAC;aAAM,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YACrC,uFAAuF;YACvF,aAAa,GAAG,SAAS,CAAC;YAC1B,iBAAiB,GAAG,WAAW,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,0CAA0C;YAC1C,iBAAiB,GAAG,oBAAgC,CAAC;QACvD,CAAC;QAED,0EAA0E;QAC1E,IAAI,iBAAiB,EAAE,CAAC;YACtB,+EAA+E;YAC/E,mFAAmF;YACnF,gCAAgC;YAChC,IAAI,CAAC,CAAC,iBAAiB,YAAY,uBAAQ,CAAC,EAAE,CAAC;gBAC7C,MAAM,CAAC,GAAG,iBAAwB,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;oBAClD,mDAAmD;oBACnD,iBAAiB,GAAG,IAAI,uBAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;gBACzD,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,qMAAqM,CACtM,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,UAAU,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,mBAAmB,CAAC,UAAkB,EAAE,UAAwB,EAAE,WAAsB;QACnG,IAAI,MAAM,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,IAA6B,EAAE,WAAsB;QACrF,yEAAyE;QACzE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBAC1F,MAAM,IAAI,KAAK,CACb,8EAA8E,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,sBAAsB,CACvH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,0DAA0D;gBAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACnE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;wBAC3F,MAAM,IAAI,KAAK,CACb,6EAA6E;4BAC3E,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,SAAS,CACnD,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sBAAsB;QACjC,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,0BAA0B;QACrC,MAAM,QAAQ,CAAC,QAAQ,CAAC,0BAA0B,EAAE,CAAC;IACvD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,8BAA8B;QACzC,MAAM,QAAQ,CAAC,QAAQ,CAAC,8BAA8B,EAAE,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAW,oBAAoB;QAC7B,OAAO,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CACjC,WAAmB,EACnB,WAAqC,EACrC,WAAsB,EACtB,aAAiC;QAEjC,OAAO,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IACxG,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAC3B,WAAmB,EACnB,WAAqC,EACrC,WAAsB,EACtB,aAAiC;QAEjC,OAAO,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IAClG,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAAmB,EACnB,WAAqC,EACrC,WAAsB;QAEtB,OAAO,QAAQ,CAAC,QAAQ,CAAC,wBAAwB,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,sBAAsB,CAAC,WAAmB,EAAE,WAAqC;QAC5F,OAAO,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAAC,WAAmB,EAAE,WAAqC;QACtF,OAAO,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,WAAoC,EAAE,OAA0B;QAC7G,OAAO,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAAC,WAAmB,EAAE,WAAqC;QACrF,OAAO,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,WAAmB,EAAE,WAAqC;QAClF,OAAO,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iBAAiB,CAAC,WAAmB,EAAE,WAAqC;QACvF,OAAO,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC;IACtC,CAAC;;AAzjBH,4BA0jBC;AAzjBgB,2BAAkB,GAAW,qBAAqB,CAAC"}

package/dist/generic/metadataUtil.d.ts

@@ -0,0 +1,8 @@
+import { IMetadataProvider } from "./interfaces";
+/**
+ * This function is used to get the entity name from the schema.view string
+ * @param schemaAndView - this string contains the combined schema name and base view name, for example: "dbo.vwMyView"
+ * @param provider - optional, if you want to use a different provider than the default one
+ */
+export declare function GetEntityNameFromSchemaAndViewString(schemaAndView: string, provider?: IMetadataProvider): string | null;
+//# sourceMappingURL=metadataUtil.d.ts.map

package/dist/generic/metadataUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadataUtil.d.ts","sourceRoot":"","sources":["../../src/generic/metadataUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGjD;;;;GAIG;AACH,wBAAgB,oCAAoC,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI,CA0BvH"}

package/dist/generic/metadataUtil.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetEntityNameFromSchemaAndViewString = void 0;
+const metadata_1 = require("./metadata");
+/**
+ * This function is used to get the entity name from the schema.view string
+ * @param schemaAndView - this string contains the combined schema name and base view name, for example: "dbo.vwMyView"
+ * @param provider - optional, if you want to use a different provider than the default one
+ */
+function GetEntityNameFromSchemaAndViewString(schemaAndView, provider) {
+    const p = provider || new metadata_1.Metadata();
+    // check to see if the view has a . in it, that would mean it has schema and view name, SHOULD always have that
+    let schema = '', view = '';
+    if (schemaAndView.indexOf('.') === -1) {
+        view = schemaAndView.trim().toLowerCase();
+    }
+    else {
+        schema = schemaAndView.split('.')[0].trim().toLowerCase();
+        view = schemaAndView.split('.')[1].trim().toLowerCase();
+    }
+    const e = p.Entities.filter((x) => x.BaseView.trim().toLowerCase() === view && (schema === '' || x.SchemaName.trim().toLowerCase() === schema)); // try to find the entity even if we don't have the schema name. AI should include it in schema.view syntax but if it doesn't we'll try to find
+    if (e && e.length === 1) {
+        return e[0].Name;
+    }
+    else if (!e || e.length === 0) {
+        console.warn(`Could not find entity for the specified DrillDownView: ${schemaAndView}`);
+        return null;
+    }
+    else if (e && e.length > 1) {
+        console.warn(`Found more than one entity for the specified DrillDownView: ${schemaAndView}`);
+        return null;
+    }
+    return null;
+}
+exports.GetEntityNameFromSchemaAndViewString = GetEntityNameFromSchemaAndViewString;
+//# sourceMappingURL=metadataUtil.js.map

package/dist/generic/metadataUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadataUtil.js","sourceRoot":"","sources":["../../src/generic/metadataUtil.ts"],"names":[],"mappings":";;;AACA,yCAAsC;AAEtC;;;;GAIG;AACH,SAAgB,oCAAoC,CAAC,aAAqB,EAAE,QAA4B;IACpG,MAAM,CAAC,GAAG,QAAQ,IAAI,IAAI,mBAAQ,EAAE,CAAC;IACrC,+GAA+G;IAC/G,IAAI,MAAM,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE,CAAC;IAC3B,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACpC,IAAI,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9C,CAAC;SACI,CAAC;QACF,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC1D,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC5D,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CACvB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CACrH,CAAC,CAAC,+IAA+I;IAClJ,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACrB,CAAC;SACI,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,CAAC,IAAI,CAAC,0DAA0D,aAAa,EAAE,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC;IAChB,CAAC;SACI,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,+DAA+D,aAAa,EAAE,CAAC,CAAC;QAC7F,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AA1BD,oFA0BC"}