@memberjunction/core 0.9.0

package/dist/views/UserViewEntityBase.js

@@ -0,0 +1,466 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewGridState = exports.ViewSortInfo = exports.ViewSortDirectionInfo = exports.ViewFilterInfo = exports.ViewFilterLogicInfo = exports.ViewColumnInfo = exports.ViewInfo = exports.UserViewEntityBase = void 0;
+const mj_global_1 = require("mj_global");
+const metadata_1 = require("../generic/metadata");
+const baseEntity_1 = require("../generic/baseEntity");
+const baseInfo_1 = require("../generic/baseInfo");
+const runView_1 = require("./runView");
+let UserViewEntityBase = class UserViewEntityBase extends baseEntity_1.BaseEntity {
+    constructor() {
+        super(...arguments);
+        this._ViewEntityInfo = null;
+    }
+    /**
+     * This is a read-only property that returns the filters for this view. This information
+     * is persisted in a JSON format in the FilterState column of the UserViewEntity table. To access
+     * the filters easily, use this property.
+     * @readonly
+     * @type {ViewFilterInfo[]}
+     * @memberof UserViewEntitySubclass
+     */
+    get Filter() {
+        if (this.FilterState) {
+            return [new ViewFilterInfo(JSON.parse(this.FilterState))];
+        }
+        else
+            return [];
+    }
+    /**
+     * This is a read-only property that returns the columns for this view. This information
+     * is persisted in a JSON format in the GridState column of the UserViewEntity table. To access
+     * the columns easily, use this property.
+     */
+    get Columns() {
+        // now, we need to do some post-processing once we've loaded the raw data so that our 
+        // columns and filters are set up correctly
+        if (this.GridState) {
+            const gridState = JSON.parse(this.GridState);
+            if (gridState && gridState.columnSettings) {
+                const columns = gridState.columnSettings.map(c => {
+                    // find the entity field and put it in place inside the View Metadata for easy access
+                    if (c) {
+                        // check to make sure the current item is non-null to ensure metadata isn't messed up 
+                        const field = this._ViewEntityInfo.Fields.find(f => f.Name.trim().toLowerCase() == c.Name.trim().toLowerCase());
+                        return new ViewColumnInfo({ ...c, EntityField: field });
+                    }
+                    else {
+                        console.log('null column setting found in view grid state for columns - ViewID: ' + this.ID);
+                    }
+                });
+                return columns;
+            }
+        }
+        // if we get here, we don't have column info, return an empty array
+        return [];
+    }
+    /**
+     * The entity info for the entity that this view is based on
+     * @readonly
+     * @type {EntityInfo}
+     * @memberof UserViewEntitySubclass
+     */
+    get ViewEntityInfo() {
+        return this._ViewEntityInfo;
+    }
+    get ViewSortInfo() {
+        if (this.SortState) {
+            const sortTemp = JSON.parse(this.SortState);
+            if (sortTemp && sortTemp.length > 0)
+                return sortTemp.map(s => new ViewSortInfo(s));
+        }
+        // if we get here return a blank array
+        return [];
+    }
+    get OrderByClause() {
+        if (this.ViewSortInfo && this.ViewSortInfo.length > 0) {
+            return this.ViewSortInfo.map(s => s.field + (s.direction === ViewSortDirectionInfo.Asc ? '' : ' DESC')).join(', ');
+        }
+        else
+            return '';
+    }
+    LoadFromData(data) {
+        // in this case we need to make sure we ge the _ViewEntityInfo property set up correctly
+        if (data && data.EntityID) {
+            const md = new metadata_1.Metadata();
+            const match = md.Entities.find(e => e.ID == data.EntityID);
+            if (match) {
+                this._ViewEntityInfo = match;
+            }
+            else {
+                throw new Error('Unable to find entity info for entity ID: ' + data.EntityID);
+            }
+        }
+        return super.LoadFromData(data);
+    }
+    async Load(ID, EntityRelationshipsToLoad) {
+        // first load up the view info, use the superclass to do this
+        const result = await super.Load(ID, EntityRelationshipsToLoad);
+        if (result) {
+            const md = new metadata_1.Metadata();
+            // first, cache a copy of the entity info for the entity that is used in this view
+            const match = md.Entities.find(e => e.ID == this.EntityID);
+            if (match)
+                this._ViewEntityInfo = match;
+            else
+                throw new Error('Unable to find entity info for entity ID: ' + this.EntityID);
+        }
+        return result;
+    }
+    async Save(options) {
+        // we want to preprocess the Save() call because we need to regenerate the WhereClause in some situations
+        if (options?.IgnoreDirtyState ||
+            this.Fields.find(c => c.Name.toLowerCase() == 'filterstate')?.Dirty) {
+            // either we're ignoring dirty state or the filter state is dirty, so we need to update the where clause
+            this.UpdateWhereClause();
+        }
+        // now just call our superclass to do the actual save()
+        return super.Save(options);
+    }
+    async SetDefaultsFromEntity(e) {
+        this.EntityID = e.ID;
+        const newGridState = new ViewGridState();
+        newGridState.columnSettings = [];
+        e.Fields.filter(f => f.DefaultInView).forEach(f => {
+            newGridState.columnSettings.push({
+                ID: f.ID,
+                DisplayName: f.DisplayName,
+                Name: f.Name,
+                hidden: false,
+                width: f.DefaultColumnWidth,
+                orderIndex: newGridState.columnSettings.length
+            });
+        });
+        this.GridState = JSON.stringify(newGridState); // default columns for a view are the ones with DefaultInView turned on
+    }
+    NewRecord() {
+        const result = super.NewRecord();
+        if (result) {
+            if (this.ContextCurrentUser) {
+                this.UserID = this.ContextCurrentUser.ID;
+            }
+            else {
+                const md = new metadata_1.Metadata();
+                if (md.CurrentUser)
+                    this.UserID = md.CurrentUser.ID;
+                else
+                    throw new Error('Unable to determine current user for new view record');
+            }
+            this.Name = '';
+            this.IsShared = false;
+            this.IsDefault = false;
+            this.WhereClause = '';
+            this.Description = '';
+            this.FilterState = JSON.stringify({ "logic": "and", "filters": [] }); // blank default for filter
+            this.GridState = JSON.stringify({}); // blank object initially
+            this.CustomFilterState = false;
+            this.CustomWhereClause = false;
+        }
+        return result;
+    }
+    /**
+     * This method is used to update the view's filter state. It will update the FilterState column by calling GenerateWhereClause().
+     * It does not save anything. You still call .Save() to save the record as desired. If you want to get the new WhereClause based on the FilterState but not
+     * update the FilterState column, call GenerateWhereClause() directly.
+     */
+    UpdateWhereClause() {
+        this.WhereClause = this.GenerateWhereClause(this.FilterState, this.ViewEntityInfo);
+    }
+    Set(FieldName, Value) {
+        // call the superclass first and set the value internally there
+        super.Set(FieldName, Value);
+        if (FieldName.toLowerCase() == 'entityid') {
+            // we're updating the entityID, need to upate the _ViewEntityInfo property so it is always in sync
+            const md = new metadata_1.Metadata();
+            const match = md.Entities.find(e => e.ID == Value);
+            if (match)
+                this._ViewEntityInfo = match;
+            else
+                throw new Error('Unable to find entity info for entity ID: ' + Value);
+        }
+    }
+    /**
+     * Create a where clause for SQL from the structured filter state JSON information
+     * @param FilterState A string containing a valid Filter State JSON string - this uses the format that the Kendo Filter component uses which is generic and can be used anywhere
+     * with/without kendo
+     * @param EntityInfo The entity info for the entity that the UserView is based on
+     * @returns a string that represents a valid SQL WHERE clause
+     * @memberof UserViewEntitySubclass
+     * @example Example Filter State JSON below
+        FilterState = `{
+          "logic": "or",
+          "filters": [{
+            "field": "Name",
+            "operator": "startswith",
+            "value": "A"
+          }, {
+            "logic": "or",
+            "filters": [{
+              "field": "TotalRevenue",
+              "operator": "gt",
+              "value": 10000000
+            }, {
+              "field": "NumberEmployees",
+              "operator": "gte",
+              "value": 25
+            }, {
+              "field": "InformationTechnologyExpense",
+              "operator": "gte",
+              "value": 500000
+            }, {
+              "logic": "and",
+              "filters": [{
+                "field": "City",
+                "operator": "eq",
+                "value": "Chicago"
+              }, {
+                "field": "ActivityCount",
+                "operator": "gte",
+                "value": 5
+              }]
+            }]
+          }, {
+            "field": "LatestActivityDate",
+            "operator": "gte",
+            "value": "2023-01-01T06:00:00.000Z"
+          }]
+        }`;
+     */
+    GenerateWhereClause(FilterState, entityInfo) {
+        return this.processFilterGroup(JSON.parse(FilterState), entityInfo);
+    }
+    wrapQuotes(value, needQuotes) {
+        return needQuotes ? `'${value}'` : value;
+    }
+    convertFilterToSQL(field, operator, value, entity) {
+        let op = '';
+        let bNeedsQuotes = false;
+        const f = entity.Fields.find((f) => f.Name.trim().toLowerCase() === field.trim().toLowerCase());
+        if (!f)
+            throw new Error('Unable to find field ' + field + ' in entity ' + entity.Name);
+        switch (f.Type.toLowerCase().trim()) {
+            case 'nvarchar':
+            case 'char':
+            case 'varchar':
+            case 'text':
+            case 'ntext':
+            case 'date':
+            case 'datetime':
+            case 'datetimeoffset':
+            case 'time':
+            case 'guid':
+            case 'uniqueidentifier':
+                bNeedsQuotes = true;
+                break;
+            // all other cases do not need quotes
+        }
+        switch (operator) {
+            case 'eq':
+                op = '= ' + this.wrapQuotes(value, bNeedsQuotes);
+                break;
+            case 'neq':
+                op = '<> ' + this.wrapQuotes(value, bNeedsQuotes);
+                break;
+            case 'gt':
+                op = '> ' + this.wrapQuotes(value, bNeedsQuotes);
+                break;
+            case 'gte':
+                op = '>= ' + this.wrapQuotes(value, bNeedsQuotes);
+                break;
+            case 'lt':
+                op = '< ' + this.wrapQuotes(value, bNeedsQuotes);
+                break;
+            case 'lte':
+                op = '<= ' + this.wrapQuotes(value, bNeedsQuotes);
+                break;
+            case 'startswith':
+                op = `LIKE '${value}%'`;
+                break;
+            case 'endswith':
+                op = `LIKE '%${value}'`;
+                break;
+            case 'contains':
+                op = `LIKE '%${value}%'`;
+                break;
+            case 'doesnotcontain':
+                op = `NOT LIKE '%${value}%'`;
+                break;
+            case 'isnull':
+            case 'isempty':
+                op = 'IS NULL';
+                break;
+            case 'isnotnull':
+            case 'isnotempty':
+                op = 'IS NOT NULL';
+                break;
+        }
+        return `[${field}] ${op}`;
+    }
+    processFilterGroup(filterGroup, entity) {
+        // each filter has two properties, logic and filters
+        // logic is either 'and' or 'or' and is what we use to determine the SQL logic operator
+        // filters is an array of filters, each filter has a field, operator, and value,
+        let whereClause = '';
+        let bFirst = true;
+        const logic = filterGroup.logic.toUpperCase();
+        for (const filter of filterGroup.filters) {
+            if (!bFirst)
+                whereClause += ` ${logic} `;
+            else
+                bFirst = false;
+            // if an individual filter has a "logic" property, it's a group and we need to process it with parenthesis and recurisely
+            if (filter.logic && filter.logic.length > 0) {
+                // this is a group, we process it with parenthesis
+                whereClause += `(${this.processFilterGroup(filter, entity)})`;
+            }
+            else {
+                // this is an individual filter, easy to process
+                whereClause += `(${this.convertFilterToSQL(filter.field, filter.operator, filter.value, entity)})`;
+            }
+        }
+        return whereClause;
+    }
+};
+UserViewEntityBase = __decorate([
+    (0, mj_global_1.RegisterClass)(baseEntity_1.BaseEntity, 'User Views', -1) // -1 priority because we want the generated UserViewEntity class to be used ahead of this and it gets generated with a priority of 0 by default
+], UserViewEntityBase);
+exports.UserViewEntityBase = UserViewEntityBase;
+class ViewInfo {
+    /**
+     * Returns a list of views for the specified user. If no user is specified, the current user is used.
+     * @param contextUser optional, the user to use for context when loading the view
+     * @param entityId optional, the entity ID to filter the views by, if not provided, there is no filter on EntityID and all views for the user are returned
+     * @returns an array of UserViewEntityBase objects
+     * @memberof ViewInfo
+     * @static
+     * @async
+     */
+    static async GetViewsForUser(entityId, contextUser) {
+        const rv = new runView_1.RunView();
+        const md = new metadata_1.Metadata();
+        const result = await rv.RunView({
+            EntityName: 'User Views',
+            ExtraFilter: `UserID = ${contextUser ? contextUser.ID : md.CurrentUser.ID}
+                         ${entityId ? ` AND EntityID = ${entityId}` : ''}`
+        });
+        const rd = result?.Results;
+        if (result && result.Success && rd)
+            return rd;
+    }
+    /**
+     * Returns a view ID for a given viewName
+     * @param viewName Name of the view to lookup the ID for
+     * @returns the ID of the User View record that matches the provided name, if found
+     */
+    static async GetViewID(viewName) {
+        const rv = new runView_1.RunView();
+        const result = await rv.RunView({ EntityName: 'User Views', ExtraFilter: `Name = '${viewName}'` });
+        const rd = result?.Results;
+        if (result && result.Success && rd && rd.length > 0) {
+            return rd[0].ID;
+        }
+        else {
+            throw new Error('Unable to find view with name: ' + viewName);
+        }
+    }
+    /**
+     * Loads a new entity object for User Views for the specified viewId and returns it if successful.
+     * @param viewId record ID for the view to load
+     * @param contextUser optional, the user to use for context when loading the view
+     * @returns UserViewEntityBase (or a subclass of it)
+     * @throws Error if the view cannot be loaded
+     * @memberof ViewInfo
+     * @static
+     * @async
+     */
+    static async GetViewEntity(viewId, contextUser) {
+        const md = new metadata_1.Metadata();
+        const view = await md.GetEntityObject('User Views', contextUser);
+        if (await view.Load(viewId))
+            return view;
+        else
+            throw new Error('Unable to load view with ID: ' + viewId);
+    }
+    /**
+     * Loads a new entity object for User Views for the specified viewName and returns it if successful.
+     * @param viewName name for the view to load
+     * @param contextUser optional, the user to use for context when loading the view
+     * @returns UserViewEntityBase (or a subclass of it)
+     * @throws Error if the view cannot be loaded
+     * @memberof ViewInfo
+     * @static
+     * @async
+     */
+    static async GetViewEntityByName(viewName, contextUser) {
+        const viewId = await ViewInfo.GetViewID(viewName);
+        if (viewId)
+            return await ViewInfo.GetViewEntity(viewId, contextUser);
+        else
+            throw new Error('Unable to find view with name: ' + viewName);
+    }
+}
+exports.ViewInfo = ViewInfo;
+class ViewColumnInfo extends baseInfo_1.BaseInfo {
+    constructor(initData = null) {
+        super();
+        this.ID = null;
+        this.Name = null;
+        this.DisplayName = null;
+        this.hidden = null;
+        this.width = null;
+        this.orderIndex = null;
+        this.EntityField = null;
+        this.copyInitData(initData);
+    }
+}
+exports.ViewColumnInfo = ViewColumnInfo;
+var ViewFilterLogicInfo;
+(function (ViewFilterLogicInfo) {
+    ViewFilterLogicInfo[ViewFilterLogicInfo["And"] = 1] = "And";
+    ViewFilterLogicInfo[ViewFilterLogicInfo["Or"] = 2] = "Or";
+})(ViewFilterLogicInfo = exports.ViewFilterLogicInfo || (exports.ViewFilterLogicInfo = {}));
+class ViewFilterInfo extends baseInfo_1.BaseInfo {
+    constructor(initData = null) {
+        super();
+        this.logicOperator = null;
+        this.field = null;
+        this.operator = null;
+        this.value = null;
+        this.filters = [];
+        this.copyInitData(initData);
+        if (initData && initData.logic) {
+            this.logicOperator = initData.logic.trim().toLowerCase() == 'and' ? ViewFilterLogicInfo.And : ViewFilterLogicInfo.Or;
+        }
+        if (initData && initData.filters) {
+            this.filters = initData.filters.map(f => new ViewFilterInfo(f));
+        }
+    }
+}
+exports.ViewFilterInfo = ViewFilterInfo;
+var ViewSortDirectionInfo;
+(function (ViewSortDirectionInfo) {
+    ViewSortDirectionInfo[ViewSortDirectionInfo["Asc"] = 1] = "Asc";
+    ViewSortDirectionInfo[ViewSortDirectionInfo["Desc"] = 2] = "Desc";
+})(ViewSortDirectionInfo = exports.ViewSortDirectionInfo || (exports.ViewSortDirectionInfo = {}));
+class ViewSortInfo extends baseInfo_1.BaseInfo {
+    constructor(initData = null) {
+        super();
+        this.field = null;
+        this.direction = null;
+        this.copyInitData(initData);
+        if (initData && initData.dir && typeof initData.dir == 'string') {
+            this.direction = initData.dir.trim().toLowerCase() == 'asc' ? ViewSortDirectionInfo.Asc : ViewSortDirectionInfo.Desc;
+        }
+    }
+}
+exports.ViewSortInfo = ViewSortInfo;
+class ViewGridState {
+}
+exports.ViewGridState = ViewGridState;
+//# sourceMappingURL=UserViewEntityBase.js.map

package/dist/views/UserViewEntityBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserViewEntityBase.js","sourceRoot":"","sources":["../../src/views/UserViewEntityBase.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yCAA0C;AAC1C,kDAA+C;AAC/C,sDAAmD;AACnD,kDAA+C;AAE/C,uCAAoC;AAMpC,IAAa,kBAAkB,GAA/B,MAAa,kBAAmB,SAAQ,uBAAU;IAAlD;;QACY,oBAAe,GAAe,IAAI,CAAA;IAuV9C,CAAC;IArVG;;;;;;;OAOG;IACH,IAAW,MAAM;QACb,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,OAAO,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;SAC5D;;YAEG,OAAO,EAAE,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,OAAO;QACd,sFAAsF;QACtF,2CAA2C;QAC3C,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC5C,IAAI,SAAS,IAAI,SAAS,CAAC,cAAc,EAAE;gBACvC,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;oBAC7C,qFAAqF;oBACrF,IAAI,CAAC,EAAE;wBACH,sFAAsF;wBACtF,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;wBAC/G,OAAO,IAAI,cAAc,CAAC,EAAC,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,EAAC,CAAC,CAAA;qBACxD;yBACI;wBACD,OAAO,CAAC,GAAG,CAAC,qEAAqE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAA;qBAC/F;gBACL,CAAC,CAAC,CAAA;gBAEF,OAAO,OAAO,CAAC;aAClB;SACJ;QAED,mEAAmE;QACnE,OAAO,EAAE,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAA;IAC/B,CAAC;IAED,IAAW,YAAY;QACnB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC3C,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBAC/B,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;SACpD;QACD,sCAAsC;QACtC,OAAO,EAAE,CAAA;IACb,CAAC;IAED,IAAW,aAAa;QACpB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,KAAK,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACtH;;YAEG,OAAO,EAAE,CAAA;IACjB,CAAC;IAEQ,YAAY,CAAC,IAAS;QAC3B,wFAAwF;QACxF,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACvB,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,IAAI,KAAK,EAAE;gBACP,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;aAC/B;iBACI;gBACD,MAAM,IAAI,KAAK,CAAC,4CAA4C,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;aAChF;SACJ;QACD,OAAO,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAEQ,KAAK,CAAC,IAAI,CAAC,EAAU,EAAE,yBAAoC;QAChE,6DAA6D;QAC7D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,yBAAyB,CAAC,CAAA;QAC9D,IAAI,MAAM,EAAE;YACR,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC1B,kFAAkF;YAClF,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,IAAI,KAAK;gBACL,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;;gBAE5B,MAAM,IAAI,KAAK,CAAC,4CAA4C,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;SACpF;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEQ,KAAK,CAAC,IAAI,CAAC,OAA2B;QAC3C,yGAAyG;QACzG,IAAI,OAAO,EAAE,gBAAgB;YACzB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE;YACrE,wGAAwG;YACxG,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC5B;QAED,uDAAuD;QACvD,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,CAAa;QAC5C,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,YAAY,GAAG,IAAI,aAAa,EAAE,CAAC;QACzC,YAAY,CAAC,cAAc,GAAG,EAAE,CAAC;QACjC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC9C,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC;gBAC7B,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,CAAC,CAAC,kBAAkB;gBAC3B,UAAU,EAAE,YAAY,CAAC,cAAc,CAAC,MAAM;aACjD,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,uEAAuE;IAC1H,CAAC;IAEQ,SAAS;QACd,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;QAChC,IAAI,MAAM,EAAE;YACR,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;aAC5C;iBACI;gBACD,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;gBAC1B,IAAI,EAAE,CAAC,WAAW;oBACd,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC;;oBAEhC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;aAC/E;YACD,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,OAAO,EAAG,KAAK,EAAE,SAAS,EAAG,EAAE,EAAE,CAAC,CAAC,CAAC,2BAA2B;YAClG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,yBAAyB;YAC9D,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;SAClC;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACI,iBAAiB;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACvF,CAAC;IAEe,GAAG,CAAC,SAAiB,EAAE,KAAU;QAC7C,+DAA+D;QAC/D,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAE5B,IAAI,SAAS,CAAC,WAAW,EAAE,IAAI,UAAU,EAAE;YACvC,kGAAkG;YAClG,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,CAAC,CAAA;YAClD,IAAI,KAAK;gBACL,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;;gBAE5B,MAAM,IAAI,KAAK,CAAC,4CAA4C,GAAG,KAAK,CAAC,CAAA;SAC5E;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACO,mBAAmB,CAAC,WAAmB,EAAE,UAAsB;QACrE,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;IAEO,UAAU,CAAC,KAAa,EAAE,UAAmB;QACjD,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7C,CAAC;IAEO,kBAAkB,CACtB,KAAa,EACb,QAAgB,EAChB,KAAa,EACb,MAAkB;QAElB,IAAI,EAAE,GAAW,EAAE,CAAC;QACpB,IAAI,YAAY,GAAY,KAAK,CAAC;QAClC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAChG,IAAI,CAAC,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,KAAK,GAAG,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAEnF,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;YACjC,KAAK,UAAU,CAAC;YAChB,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,OAAO,CAAC;YACb,KAAK,MAAM,CAAC;YACZ,KAAK,UAAU,CAAC;YAChB,KAAK,gBAAgB,CAAC;YACtB,KAAK,MAAM,CAAC;YACZ,KAAK,MAAM,CAAC;YACZ,KAAK,kBAAkB;gBACnB,YAAY,GAAG,IAAI,CAAC;gBACpB,MAAM;YACV,qCAAqC;SACxC;QACD,QAAQ,QAAQ,EAAE;YACd,KAAK,IAAI;gBACL,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBACjD,MAAM;YACV,KAAK,KAAK;gBACN,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBAClD,MAAM;YACV,KAAK,IAAI;gBACL,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBACjD,MAAM;YACV,KAAK,KAAK;gBACN,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBAClD,MAAM;YACV,KAAK,IAAI;gBACL,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBACjD,MAAM;YACV,KAAK,KAAK;gBACN,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBAClD,MAAM;YACV,KAAK,YAAY;gBACb,EAAE,GAAG,SAAS,KAAK,IAAI,CAAC;gBACxB,MAAM;YACV,KAAK,UAAU;gBACX,EAAE,GAAG,UAAU,KAAK,GAAG,CAAC;gBACxB,MAAM;YACV,KAAK,UAAU;gBACX,EAAE,GAAG,UAAU,KAAK,IAAI,CAAC;gBACzB,MAAM;YACV,KAAK,gBAAgB;gBACjB,EAAE,GAAG,cAAc,KAAK,IAAI,CAAC;gBAC7B,MAAM;YACV,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACV,EAAE,GAAG,SAAS,CAAC;gBACf,MAAM;YACV,KAAK,WAAW,CAAC;YACjB,KAAK,YAAY;gBACb,EAAE,GAAG,aAAa,CAAC;gBACnB,MAAM;SACb;QACD,OAAO,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;IAC9B,CAAC;IAEO,kBAAkB,CAAC,WAAgB,EAAE,MAAkB;QAC3D,oDAAoD;QACpD,uFAAuF;QACvF,gFAAgF;QAChF,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,MAAM,GAAY,IAAI,CAAC;QAC3B,MAAM,KAAK,GAAW,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAEtD,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,OAAO,EAAE;YACtC,IAAI,CAAC,MAAM;gBACP,WAAW,IAAI,IAAI,KAAK,GAAG,CAAC;;gBAE5B,MAAM,GAAG,KAAK,CAAC;YAEnB,yHAAyH;YACzH,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzC,kDAAkD;gBAClD,WAAW,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC;aACjE;iBAAM;gBACH,gDAAgD;gBAChD,WAAW,IAAI,IAAI,IAAI,CAAC,kBAAkB,CACtC,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,CACT,GAAG,CAAC;aACR;SACJ;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ,CAAA;AAxVY,kBAAkB;IAD9B,IAAA,yBAAa,EAAC,uBAAU,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,gJAAgJ;GAChL,kBAAkB,CAwV9B;AAxVY,gDAAkB;AA0V/B,MAAa,QAAQ;IACjB;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAiB,EAAE,WAAsB;QAClE,MAAM,EAAE,GAAG,IAAI,iBAAO,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;YAC5B,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,YAAY,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE;2BAC1D,QAAQ,CAAC,CAAC,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;SACjE,CAAC,CAAC;QACH,MAAM,EAAE,GAAG,MAAM,EAAE,OAAqB,CAAC;QACzC,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,IAAI,EAAE;YAC9B,OAAO,EAAE,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,QAAgB;QACnC,MAAM,EAAE,GAAG,IAAI,iBAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,EAAC,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,QAAQ,GAAG,EAAC,CAAC,CAAA;QAChG,MAAM,EAAE,GAAG,MAAM,EAAE,OAAqB,CAAC;QACzC,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,IAAI,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;YACjD,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;SAClB;aACI;YACD,MAAM,IAAI,KAAK,CAAC,iCAAiC,GAAG,QAAQ,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,MAAc,EAAE,WAAsB;QAC7D,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAuB,MAAM,EAAE,CAAC,eAAe,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACrF,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YACvB,OAAO,IAAI,CAAA;;YAEX,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,MAAM,CAAC,CAAA;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,WAAsB;QACrE,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,MAAM;YACN,OAAO,MAAM,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;;YAExD,MAAM,IAAI,KAAK,CAAC,iCAAiC,GAAG,QAAQ,CAAC,CAAA;IACrE,CAAC;CACJ;AA5ED,4BA4EC;AAED,MAAa,cAAe,SAAQ,mBAAQ;IAUxC,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QAVX,OAAE,GAAW,IAAI,CAAA;QACjB,SAAI,GAAW,IAAI,CAAA;QACnB,gBAAW,GAAW,IAAI,CAAA;QAC1B,WAAM,GAAY,IAAI,CAAA;QACtB,UAAK,GAAY,IAAI,CAAA;QACrB,eAAU,GAAY,IAAI,CAAA;QAE1B,gBAAW,GAAoB,IAAI,CAAA;QAI/B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACJ;AAdD,wCAcC;AAED,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,2DAAO,CAAA;IACP,yDAAM,CAAA;AACV,CAAC,EAHW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAG9B;AACD,MAAa,cAAe,SAAQ,mBAAQ;IASxC,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QATX,kBAAa,GAAwB,IAAI,CAAA;QAEzC,UAAK,GAAW,IAAI,CAAA;QACpB,aAAQ,GAAW,IAAI,CAAA;QACvB,UAAK,GAAW,IAAI,CAAA;QAEpB,YAAO,GAAqB,EAAE,CAAA;QAI1B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3B,IAAI,QAAQ,IAAI,QAAQ,CAAC,KAAK,EAAE;YAC5B,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAmB,CAAC,EAAE,CAAA;SACvH;QACD,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE;YAC9B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAA;SAClE;IACL,CAAC;CACJ;AAnBD,wCAmBC;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,+DAAO,CAAA;IACP,iEAAQ,CAAA;AACZ,CAAC,EAHW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAGhC;AACD,MAAa,YAAa,SAAQ,mBAAQ;IAItC,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QAJX,UAAK,GAAW,IAAI,CAAA;QACpB,cAAS,GAA0B,IAAI,CAAA;QAInC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3B,IAAI,QAAQ,IAAI,QAAQ,CAAC,GAAG,IAAI,OAAO,QAAQ,CAAC,GAAG,IAAI,QAAQ,EAAE;YAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAA;SACvH;IACL,CAAC;CACJ;AAXD,oCAWC;AAGD,MAAa,aAAa;CAIzB;AAJD,sCAIC"}

package/dist/views/runView.d.ts

@@ -0,0 +1,106 @@
+import { IRunViewProvider, RunViewResult } from '../generic/interfaces';
+import { UserInfo } from '../generic/securityInfo';
+import { BaseEntity } from '../generic/baseEntity';
+/**
+ * Parameters for running either a stored or dynamic view.
+ * A stored view is a view that is saved in the database and can be run either by ID or Name.
+ * A dynamic view is one that is not stored in the database and you provide parameters to return data as
+ * desired programatically.
+ */
+export type RunViewParams = {
+    /**
+     * optional - ID of the UserView record to run, if provided, ViewName is ignored
+     */
+    ViewID?: number;
+    /**
+     * optional - Name of the UserView record to run, if you are using this, make sure to use a naming convention
+     * so that your view names are unique. For example use a prefix like __Entity_View_ etc so that you're
+     * likely to have a single result. If more than one view is available that matches a provided view name an
+     * exception will be thrown.
+     */
+    ViewName?: string;
+    /**
+     * optional - this is the loaded instance of the BaseEntity (UserViewEntityComplete or a subclass of it).
+     * This is the preferred parameter to use IF you already have a view entity object loaded up in your code
+     * becuase by passing this in, the RunView() method doesn't have to lookup all the metadata for the view and it is faster.
+     * If you provide ViewEntity, ViewID/ViewName are ignored.
+     */
+    ViewEntity?: BaseEntity;
+    /**
+     * optional - this is only used if ViewID/ViewName/ViewEntity are not provided, it is used for
+     * Dynamic Views in combination with the optional ExtraFilter
+     */
+    EntityName?: string;
+    /**
+     * An optional SQL WHERE clause that you can add to the existing filters on a stored view. For dynamic views, you can either
+     * run a view without a filter (if the entity definition allows it with AllowAllRowsAPI=1) or filter with any valid SQL WHERE clause.
+     */
+    ExtraFilter?: string;
+    /**
+     * An optional SQL ORDER BY clause that you can use for dynamic views, as well as to OVERRIDE the stored view's sorting order.
+     */
+    OrderBy?: string;
+    /**
+     * An optional array of field names that you want returned. The RunView() function will always return ID so you don't need to ask for that. If you leave this null then
+     * for a dynamic view all fields are returned, and for stored views, the fields stored in it view configuration are returned.
+      */
+    Fields?: string[];
+    /**
+     * optional - string that represents a user "search" - typically from a text search option in a UI somewhere. This field is then used in the view filtering to search whichever fields are configured to be included in search in the Entity Fields definition.
+     * Search String is combined with the stored view filters as well as ExtraFilter with an AND.
+     */
+    UserSearchString?: string;
+    /**
+     * optional - if provided, records that were returned in the specified UserViewRunID will NOT be allowed in the result set.
+     * This is useful if you want to run a particular view over time and exclude a specific prior run's resulting data set. If you
+     * want to exclude ALL data returned from ALL prior runs, use the ExcludeDataFromAllPriorViewRuns property instead.
+     */
+    ExcludeUserViewRunID?: number;
+    /**
+     * optional - if set to true, the resulting data will filter out ANY records that were ever returned by this view, when the SaveViewResults property was set to true.
+     * This is useful if you want to run a particular view over time and make sure the results returned each time are new to the view.
+     */
+    ExcludeDataFromAllPriorViewRuns?: boolean;
+    /**
+     * optional - if you are providing the optional ExcludeUserViewRunID property, you can also optionally provide
+     * this filter which will negate the specific list of record IDs that are excluded by the ExcludeUserViewRunID property.
+     * This can be useful if you want to ensure a certain class of data is always allowed into your view and not filtered out
+     * by a prior view run.
+     *
+     */
+    OverrideExcludeFilter?: string;
+    /**
+     * optional - if set to true, the LIST OF ID values from the view run will be stored in the User View Runs entity and the
+     * newly created UserViewRun.ID value will be returned in the RunViewResult that the RunView() function sends back to ya.
+     */
+    SaveViewResults?: boolean;
+    /**
+     * optional - if set to true, if there IS any UserViewMaxRows property set for the entity in question, it will be IGNORED. This is useful in scenarios where you
+     * want to programmatically run a view and get ALL the data back, regardless of the MaxRows setting on the entity.
+     */
+    IgnoreMaxRows?: boolean;
+    /**
+     * optional - if set to true, the view run will ALWAYS be logged to the Audit Log, regardless of the entity's property settings for logging view runs.
+     */
+    ForceAuditLog?: boolean;
+    /**
+     * optional - if provided and either ForceAuditLog is set, or the entity's property settings for logging view runs are set to true, this will be used as the Audit Log Description.
+     */
+    AuditLogDescription?: string;
+};
+/**
+ * Class for runnings views in a generic, tier-independent manner - uses a provider model for
+ * implementation transparently from the viewpoint of the consumer of the class.
+ */
+export declare class RunView {
+    /**
+     * Runs a view based on the provided parameters, see documentation for RunViewParams for more
+     * @param params
+     * @param contextUser if provided, this user is used for permissions and logging. For server based calls, this is generally required because there is no "Current User" since this object is shared across all requests.
+     * @returns
+     */
+    RunView(params: RunViewParams, contextUser?: UserInfo): Promise<RunViewResult>;
+    private static _globalProviderKey;
+    static get Provider(): IRunViewProvider;
+    static set Provider(value: IRunViewProvider);
+}

package/dist/views/runView.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunView = void 0;
+const mj_global_1 = require("mj_global");
+/**
+ * Class for runnings views in a generic, tier-independent manner - uses a provider model for
+ * implementation transparently from the viewpoint of the consumer of the class.
+ */
+class RunView {
+    /**
+     * Runs a view based on the provided parameters, see documentation for RunViewParams for more
+     * @param params
+     * @param contextUser if provided, this user is used for permissions and logging. For server based calls, this is generally required because there is no "Current User" since this object is shared across all requests.
+     * @returns
+     */
+    async RunView(params, contextUser) {
+        return RunView.Provider.RunView(params, contextUser);
+    }
+    static get Provider() {
+        const g = mj_global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            return g[RunView._globalProviderKey];
+        else
+            throw new Error('No global object store, so we cant get the static provider');
+    }
+    static set Provider(value) {
+        const g = mj_global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            g[RunView._globalProviderKey] = value;
+        else
+            throw new Error('No global object store, so we cant set the static provider');
+    }
+}
+RunView._globalProviderKey = 'MJ_RunViewProvider';
+exports.RunView = RunView;
+//# sourceMappingURL=runView.js.map

package/dist/views/runView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runView.js","sourceRoot":"","sources":["../../src/views/runView.ts"],"names":[],"mappings":";;;AAAA,yCAAqC;AA6FrC;;;GAGG;AACH,MAAa,OAAO;IAChB;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,WAAsB;QAC9D,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAGM,MAAM,KAAK,QAAQ;QACtB,MAAM,CAAC,GAAG,oBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YACD,OAAO,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;;YAErC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACtF,CAAC;IACM,MAAM,KAAK,QAAQ,CAAC,KAAuB;QAC9C,MAAM,CAAC,GAAG,oBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YACD,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;;YAEtC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACtF,CAAC;;AAdc,0BAAkB,GAAW,oBAAoB,CAAC;AAXxD,0BAAO"}