@memberjunction/global 2.111.0 → 2.112.0

package/dist/generic/util.js

@@ -0,0 +1,301 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StripContainingParens = exports.StripSingleQuotes = exports.StripUnicodePrefix = exports.ExtractActualDefaultValue = exports.Concurrent = exports.CodeNameFromString = exports.StripStopWords = exports.CommonStopWords = exports.SQLMaxLength = exports.SQLFullType = exports.FormatValue = exports.TypeScriptTypeFromSQLTypeWithNullableOption = exports.TypeScriptTypeFromSQLType = void 0;
+const logging_1 = require("./logging");
+/**
+ * Returns the TypeScript type that corresponds to the SQL type passed in
+ */
+function TypeScriptTypeFromSQLType(sqlType) {
+    switch (sqlType.trim().toLowerCase()) {
+        case 'text':
+        case 'char':
+        case 'varchar':
+        case 'ntext':
+        case 'nchar':
+        case 'nvarchar':
+        case 'uniqueidentifier': //treat this as a string
+            return 'string';
+        case 'datetime':
+        case 'datetime2':
+        case 'datetimeoffset':
+        case 'date':
+        case 'time':
+            return 'Date';
+        case 'bit':
+            return 'boolean';
+        default:
+            return 'number';
+    }
+}
+exports.TypeScriptTypeFromSQLType = TypeScriptTypeFromSQLType;
+function TypeScriptTypeFromSQLTypeWithNullableOption(sqlType, addNullableOption) {
+    const retVal = TypeScriptTypeFromSQLType(sqlType);
+    if (addNullableOption) {
+        return retVal + ' | null';
+    }
+    else {
+        return retVal;
+    }
+}
+exports.TypeScriptTypeFromSQLTypeWithNullableOption = TypeScriptTypeFromSQLTypeWithNullableOption;
+/**
+ * Formats a value based on the parameters passed in
+ * @param sqlType - Required - the base type in SQL Server, for example int, nvarchar, etc. For types that have a length like numeric(28,4) or nvarchar(50) do NOT provide the length, just numeric and nvarchar in those examples
+ * @param value - Value to format
+ * @param decimals Number of decimals to show, defaults to 2
+ * @param currency Currency to use when formatting, defaults to USD
+ * @param maxLength Maximum length of the string to return, if the formatted value is longer than this length then the string will be truncated and the trailingChars will be appended to the end of the string
+ * @param trailingChars Only used if maxLength is > 0 and the string being formatted is > maxLength, this is the string that will be appended to the end of the string to indicate that it was truncated, defaults to "..."
+ * @returns either the original string value or a formatted version. If the format cannot be applied an an exception occurs it is captured and the error is put to the log, and the original value is returned
+ */
+function FormatValue(sqlType, value, decimals = 2, currency = 'USD', maxLength = 0, trailingChars = "...") {
+    try {
+        const retVal = FormatValueInternal(sqlType, value, decimals, currency, maxLength, trailingChars);
+        if (maxLength > 0 && retVal && retVal.length > maxLength)
+            return retVal.substring(0, maxLength) + trailingChars;
+        else
+            return retVal;
+    }
+    catch (e) {
+        (0, logging_1.LogError)(`Error formatting value ${value} of type ${sqlType} with decimals ${decimals} and currency ${currency}`, e);
+        return value; // just return the value as is if we cant format it
+    }
+}
+exports.FormatValue = FormatValue;
+// internal only function used by FormatValue() to do the actual formatting
+function FormatValueInternal(sqlType, value, decimals = 2, currency = 'USD', maxLength = 0, trailingChars = "...") {
+    if (value === null || value === undefined) {
+        return value;
+    }
+    switch (sqlType.trim().toLowerCase()) {
+        case 'money':
+            if (isNaN(value))
+                return value;
+            else
+                return new Intl.NumberFormat(undefined, { style: 'currency',
+                    currency: currency,
+                    minimumFractionDigits: decimals,
+                    maximumFractionDigits: decimals }).format(value);
+        case 'date':
+        case 'time':
+        case 'datetime':
+        case 'datetime2':
+        case 'datetimeoffset':
+            let date = new Date(value);
+            return new Intl.DateTimeFormat().format(date);
+        case 'decimal':
+        case 'real':
+        case 'float':
+            return new Intl.NumberFormat(undefined, { minimumFractionDigits: decimals, maximumFractionDigits: decimals }).format(value);
+        case 'int':
+            return new Intl.NumberFormat(undefined, { minimumFractionDigits: 0, maximumFractionDigits: 0 }).format(value);
+        case 'percent':
+            return new Intl.NumberFormat(undefined, { style: 'percent',
+                minimumFractionDigits: decimals,
+                maximumFractionDigits: decimals }).format(value);
+        default:
+            return value;
+    }
+}
+/**
+ * Returns a string that contains the full SQL type including length, precision and scale if applicable
+ * @param baseType
+ * @param length
+ * @param precision
+ * @param scale
+ * @returns
+ */
+function SQLFullType(baseType, length, precision, scale) {
+    const type = baseType.trim().toLowerCase();
+    let sOutput = type;
+    if (type === 'varchar')
+        sOutput += `(${length > 0 ? length : 'MAX'})`;
+    else if (type === 'nvarchar')
+        sOutput += `(${length > 0 ? length / 2 : 'MAX'})`; // nvarchar divide the system length by 2 to get the actual length for the output
+    else if (type === 'char')
+        sOutput += `(${length})`;
+    else if (type === 'nchar')
+        sOutput += `(${length / 2})`; // nchar divide the system length by 2 to get the actual length for the output
+    else if (type === 'decimal' || type === 'numeric')
+        sOutput += `(${precision}, ${scale})`;
+    else if (type === 'float')
+        sOutput += `(${precision})`;
+    return sOutput;
+}
+exports.SQLFullType = SQLFullType;
+/**
+ * This function determines the actual maximum length for a given SQL field based on the base type and the length specified in the schema.
+ * For example, for a varchar(50) field, the length is 50, for an nvarchar(50) field, the length is 50/2 = 25
+ * @param sqlBaseType
+ * @param sqlLength
+ * @returns
+ */
+function SQLMaxLength(sqlBaseType, sqlLength) {
+    switch (sqlBaseType.trim().toLowerCase()) {
+        case 'varchar':
+        case 'char':
+        case 'text':
+            return sqlLength;
+        case 'nvarchar':
+        case 'nchar':
+        case 'ntext':
+            return sqlLength / 2; // length in the schema is the # of bytes and on unicode fields we divide by 2 to get the # of characters a user is allowed to put in.
+        default:
+            return 0;
+    }
+}
+exports.SQLMaxLength = SQLMaxLength;
+const _stopwords = [
+    "a", "about", "above", "after", "again", "against", "ain", "all", "am", "an", "and", "any", "are", "aren", "aren't", "as", "at",
+    "be", "because", "been", "before", "being", "below", "between", "both", "but", "by",
+    "can", "couldn", "couldn't", "could",
+    "d", "did", "didn", "didn't", "do", "does", "doesn", "doesn't", "doing", "don", "don't", "down", "during",
+    "each",
+    "few", "for", "from", "further",
+    "had", "hadn", "hadn't", "has", "hasn", "hasn't", "have", "haven", "haven't", "having", "he", "her", "here", "hers", "herself", "him", "himself", "his", "how",
+    "i", "if", "in", "into", "is", "isn", "isn't", "it", "it's", "its", "itself",
+    "just",
+    "ll",
+    "m", "ma", "me", "mightn", "mightn't", "more", "most", "mustn", "mustn't", "my", "myself",
+    "needn", "needn't", "no", "nor", "not", "now",
+    "o", "of", "off", "on", "once", "only", "or", "other", "our", "ours", "ourselves", "out", "over", "own",
+    "re",
+    "s", "same", "shan", "shan't", "she", "she's", "should", "should've", "shouldn", "shouldn't", "so", "some", "such",
+    "t", "than", "that", "that'll", "the", "their", "theirs", "them", "themselves", "then", "there", "these", "they", "this", "those", "through", "to", "too",
+    "under", "until", "up",
+    "ve", "very",
+    "was", "wasn", "wasn't", "we", "were", "weren", "weren't", "what", "when", "where", "which", "while", "who", "whom", "why", "will", "with", "won", "won't", "wouldn", "wouldn't",
+    "y", "you", "you'd", "you'll", "you're", "you've", "your", "yours", "yourself", "yourselves"
+];
+/**
+ * This function returns an array of common stop words that are used in text processing
+ * @returns An array of common stop words that are used in text processing
+ */
+function CommonStopWords() {
+    return _stopwords;
+}
+exports.CommonStopWords = CommonStopWords;
+/**
+ * This function takes a string and removes common stop words from it, using the CommonStopWords() function to get the list of stop words
+ * @param inputString
+ * @returns
+ */
+function StripStopWords(inputString) {
+    const stopwordPattern = new RegExp(`\\b(${_stopwords.join('|')})\\b`, 'gi');
+    let outputString = inputString.replace(stopwordPattern, '');
+    outputString = outputString.replace(/ +/g, ' '); // Replace multiple spaces with a single space
+    return outputString;
+}
+exports.StripStopWords = StripStopWords;
+/**
+ * Returns a system-wide standard CodeName which is a programmatically acceptable identifier for a class, variable, etc using a standard replacement strategy for characters that are not acceptable in that context from a regular name
+ */
+function CodeNameFromString(input) {
+    // the code below replaces characters invalid for SQL or TypeScript identifiers with _ and stashes the result in a private variable so we only do this once
+    // Replace all invalid characters with _
+    let codeName = input.replace(/[^a-zA-Z0-9_]/g, "_");
+    // Prepend an underscore if the first character is a number
+    if (/^[0-9]/.test(codeName)) {
+        codeName = "_" + codeName;
+    }
+    return codeName;
+}
+exports.CodeNameFromString = CodeNameFromString;
+/**
+ * Run concurrent promises with a maximum concurrency level
+ * @param concurrency - The number of concurrently running promises
+ * @param funcs - An array of functions that return promises
+ * @returns A promise that resolves to an array of the resolved values from the promises returned by funcs
+ */
+function Concurrent(concurrency, funcs) {
+    return new Promise((resolve, reject) => {
+        let index = -1;
+        const p = [];
+        for (let i = 0; i < Math.max(1, Math.min(concurrency, funcs.length)); i++)
+            runPromise();
+        function runPromise() {
+            if (++index < funcs.length)
+                (p[p.length] = funcs[index]()).then(runPromise).catch(reject);
+            else if (index === funcs.length)
+                Promise.all(p).then(resolve).catch(reject);
+        }
+    });
+}
+exports.Concurrent = Concurrent;
+/**
+ * The DBMS may store the default value for a column with extra parens, for example ((1)) or (getdate()) or (('Pending')) or (('Active')) and in addition for unicode characters
+ * it may prefix the value with an N, for example N'Active'. This function will strip out the extra parens and the N prefix if it exists and return the actual default value
+ * @param storedDefaultValue - The default value as stored in the DBMS
+ */
+function ExtractActualDefaultValue(storedDefaultValue) {
+    if (!storedDefaultValue || storedDefaultValue.trim().length === 0)
+        return storedDefaultValue;
+    const noParens = StripContainingParens(storedDefaultValue);
+    const unicodeStripped = StripUnicodePrefix(noParens);
+    // now, we need to see if the unicodeStripped value is exactly equal to NULL which should be treated 
+    // as the same as no default value. Without checking this, string data types that have a DEFAULT set to NULL
+    // which is the same as no default, will end up with a STRING 'null' in the default value, but that isn't the
+    // intent. 
+    // BY CHECKING this BEFORE we strip the single quotes, we allow for a string of 'NULL', 'null' etc to exist
+    // in a string data type's default value. As odd as that might be for a string default value it should be allowed
+    if (unicodeStripped.trim().toLowerCase() === 'null') {
+        return null; // return the actual TypeScript/JavaScript null here as opposed to a string
+    }
+    else {
+        // our unicodeStripped value is NOT equal to exact match of null, so whatever we have is what we use
+        // but we strip single quotes now
+        const finalValue = StripSingleQuotes(unicodeStripped);
+        return finalValue;
+    }
+}
+exports.ExtractActualDefaultValue = ExtractActualDefaultValue;
+/**
+ * Strips out the N prefix and single quotes from a string if they exist so that a value like
+ * N'Active' becomes Active
+ */
+function StripUnicodePrefix(value) {
+    if (!value) {
+        return value;
+    }
+    value = value.trim(); // trim it first
+    // check to see if the first character is an N and if the character after
+    // that as well as the last character are single quotes, if so, strip all of those out
+    if (value && value.toUpperCase().startsWith('N') &&
+        value.length > 1 && value.charAt(1) === '\'' &&
+        value.charAt(value.length - 1) === '\'') {
+        return value.substring(2, value.length - 1); // strip out the N and the single quotes for example N'Active' becomes Active
+    }
+    return value;
+}
+exports.StripUnicodePrefix = StripUnicodePrefix;
+/**
+ * Strips out single quotes from a string if they exist so that a value like
+ * 'Active' becomes Active
+ * @param value
+ * @returns
+ */
+function StripSingleQuotes(value) {
+    if (!value)
+        return value;
+    const val = value.trim(); // trim it first
+    // now check for symmetrical single quotes and remove them
+    // this is for cases like 'Pending' or 'Active' which are stored in the DB as ('Pending') or ('Active')
+    return val.startsWith("'") && val.endsWith("'") ? val.substring(1, val.length - 1) : val;
+}
+exports.StripSingleQuotes = StripSingleQuotes;
+/**
+ * Strips out any number of symmetric containing parens from a string, for example ((0)) becomes 0
+ * and ('Active') becomes 'Active'
+ * @param value
+ * @returns
+ */
+function StripContainingParens(value) {
+    if (value.startsWith('(') && value.endsWith(')')) {
+        // recursive call so if we have ((0)) we keep stripping parens until we get to inner value
+        // could be something like (getdate()) in which case we'll only strip the SYMMENTRIC parens
+        return StripContainingParens(value.substring(1, value.length - 1));
+    }
+    return value;
+}
+exports.StripContainingParens = StripContainingParens;
+//# sourceMappingURL=util.js.map

package/dist/generic/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/generic/util.ts"],"names":[],"mappings":";;;AAAA,uCAAqC;AAErC;;GAEG;AACH,SAAgB,yBAAyB,CAAC,OAAe;IACrD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;QACnC,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS,CAAC;QACf,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,UAAU,CAAC;QAChB,KAAK,kBAAkB,EAAE,wBAAwB;YAC7C,OAAO,QAAQ,CAAC;QACpB,KAAK,UAAU,CAAC;QAChB,KAAK,WAAW,CAAC;QACjB,KAAK,gBAAgB,CAAC;QACtB,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACP,OAAO,MAAM,CAAC;QAClB,KAAK,KAAK;YACN,OAAO,SAAS,CAAC;QACrB;YACI,OAAO,QAAQ,CAAC;IACxB,CAAC;AACL,CAAC;AArBD,8DAqBC;AAED,SAAgB,2CAA2C,CAAC,OAAe,EAAE,iBAA0B;IACnG,MAAM,MAAM,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAClD,IAAI,iBAAiB,EAAE,CAAC;QACpB,OAAO,MAAM,GAAG,SAAiF,CAAC;IACtG,CAAC;SACI,CAAC;QACF,OAAO,MAAM,CAAC;IAClB,CAAC;AACL,CAAC;AARD,kGAQC;AAGD;;;;;;;;;GASG;AACH,SAAgB,WAAW,CAAC,OAAe,EACf,KAAU,EACV,WAAmB,CAAC,EACpB,WAAmB,KAAK,EACxB,YAAoB,CAAC,EACrB,gBAAwB,KAAK;IACrD,IAAI,CAAC;QACD,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACjG,IAAI,SAAS,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS;YACpD,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,aAAa,CAAC;;YAEtD,OAAO,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,CAAC,EAAE,CAAC;QACP,IAAA,kBAAQ,EAAC,0BAA0B,KAAK,YAAY,OAAO,kBAAkB,QAAQ,iBAAiB,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QACrH,OAAO,KAAK,CAAC,CAAC,mDAAmD;IACrE,CAAC;AACL,CAAC;AAjBD,kCAiBC;AAED,2EAA2E;AAC3E,SAAS,mBAAmB,CAAC,OAAe,EACf,KAAU,EACV,WAAmB,CAAC,EACpB,WAAmB,KAAK,EACxB,YAAoB,CAAC,EACrB,gBAAwB,KAAK;IACtD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;QACnC,KAAK,OAAO;YACR,IAAI,KAAK,CAAC,KAAK,CAAC;gBACZ,OAAO,KAAK,CAAC;;gBAEb,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,UAAU;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,qBAAqB,EAAE,QAAQ;oBAC/B,qBAAqB,EAAE,QAAQ,EAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5F,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU,CAAC;QAChB,KAAK,WAAW,CAAC;QACjB,KAAK,gBAAgB;YACnB,IAAI,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAChD,KAAK,SAAS,CAAC;QACf,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO;YACV,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,qBAAqB,EAAE,QAAQ,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9H,KAAK,KAAK;YACR,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChH,KAAK,SAAS;YACZ,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,SAAS;gBAChB,qBAAqB,EAAE,QAAQ;gBAC/B,qBAAqB,EAAE,QAAQ,EAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5F;YACE,OAAO,KAAK,CAAC;IACnB,CAAC;AACL,CAAC;AAGD;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAC,QAAgB,EAAE,MAAc,EAAE,SAAiB,EAAE,KAAa;IAC1F,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,OAAO,GAAW,IAAI,CAAC;IAC3B,IAAI,IAAI,KAAK,SAAS;QAClB,OAAO,IAAI,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;SAC7C,IAAI,IAAI,KAAK,UAAU;QACxB,OAAO,IAAI,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,iFAAiF;SACnI,IAAI,IAAI,KAAK,MAAM;QACpB,OAAO,IAAI,IAAI,MAAM,GAAG,CAAC;SACxB,IAAI,IAAI,KAAK,OAAO;QACrB,OAAO,IAAI,IAAI,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,8EAA8E;SAC3G,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS;QAC7C,OAAO,IAAI,IAAI,SAAS,KAAK,KAAK,GAAG,CAAC;SACrC,IAAI,IAAI,KAAK,OAAO;QACrB,OAAO,IAAI,IAAI,SAAS,GAAG,CAAC;IAEhC,OAAO,OAAO,CAAC;AACnB,CAAC;AAjBD,kCAiBC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,WAAmB,EAAE,SAAiB;IAC/D,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;QACvC,KAAK,SAAS,CAAC;QACf,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACP,OAAO,SAAS,CAAC;QACrB,KAAK,UAAU,CAAC;QAChB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACR,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC,sIAAsI;QAChK;YACI,OAAO,CAAC,CAAC;IACjB,CAAC;AACL,CAAC;AAbD,oCAaC;AAED,MAAM,UAAU,GAAG;IACf,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI;IAC/H,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI;IACnF,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO;IACpC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ;IACzG,MAAM;IACN,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS;IAC/B,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK;IAC9J,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ;IAC5E,MAAM;IACN,IAAI;IACJ,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ;IACzF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK;IAC7C,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK;IACvG,IAAI;IACJ,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM;IAClH,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK;IACzJ,OAAO,EAAE,OAAO,EAAE,IAAI;IACtB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU;IAChL,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY;CAC/F,CAAC;AAEF;;;GAGG;AACH,SAAgB,eAAe;IAC3B,OAAO,UAAU,CAAC;AACtB,CAAC;AAFD,0CAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,WAAmB;IAC9C,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5E,IAAI,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC5D,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAE,8CAA8C;IAChG,OAAO,YAAY,CAAC;AACxB,CAAC;AALD,wCAKC;AAGD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAa;IAC5C,2JAA2J;IAC3J,wCAAwC;IACxC,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAEpD,2DAA2D;IAC3D,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,QAAQ,GAAG,GAAG,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAVD,gDAUC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAI,WAAmB,EAAE,KAA2B;IAC5E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;QACf,MAAM,CAAC,GAAiB,EAAE,CAAC;QAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE;YAAE,UAAU,EAAE,CAAC;QACxF,SAAS,UAAU;YACjB,IAAI,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM;gBAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;iBACrF,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM;gBAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAVD,gCAUC;AAED;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,kBAA0B;IAChE,IAAI,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QAC7D,OAAO,kBAAkB,CAAC;IAE9B,MAAM,QAAQ,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAC3D,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAErD,qGAAqG;IACrG,4GAA4G;IAC5G,6GAA6G;IAC7G,WAAW;IACX,2GAA2G;IAC3G,iHAAiH;IACjH,IAAI,eAAe,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC,CAAE,2EAA2E;IAC7F,CAAC;SACI,CAAC;QACF,oGAAoG;QACpG,iCAAiC;QACjC,MAAM,UAAU,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAEtD,OAAO,UAAU,CAAC;IACtB,CAAC;AACL,CAAC;AAvBD,8DAuBC;AAGD;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,KAAa;IAC5C,IAAI,CAAC,KAAK,EAAC,CAAC;QACR,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,gBAAgB;IAEtC,yEAAyE;IACzE,sFAAsF;IACtF,IAAI,KAAK,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;QAC5C,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI;QAC5C,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,6EAA6E;IAC9H,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAhBD,gDAgBC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC3C,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEzB,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,gBAAgB;IAE1C,0DAA0D;IAC1D,uGAAuG;IACvG,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAC7F,CAAC;AARD,8CAQC;AAGD;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IAC/C,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,0FAA0F;QAC1F,2FAA2F;QAC3F,OAAO,qBAAqB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAPD,sDAOC"}

package/dist/views/runView.d.ts

@@ -0,0 +1,150 @@
+import { IMetadataProvider, 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?: string;
+    /**
+     * 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?: string;
+    /**
+     * 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 provided, and if IgnoreMaxRows = false, this value will be used to constrain the total # of rows returned by the view. If this is not provided, either the default settings at the entity-level will be used, or if the entity has no UserViewMaxRows setting, all rows will be returned that match any filter, if provided.
+     */
+    MaxRows?: number;
+    /**
+     * optional - if provided, this value will be used to offset the rows returned.
+     */
+    StartRow?: number;
+    /**
+     * 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;
+    /**
+     * Result Type is: 'simple', 'entity_object', or 'count_only' and defaults to 'simple'. If 'entity_object' is specified, the Results[] array will contain
+     * BaseEntity-derived objects instead of simple objects. This is useful if you want to work with the data in a more strongly typed manner and/or
+     * if you plan to do any update/delete operations on the data after it is returned. The 'count_only' option will return no rows, but the TotalRowCount property of the RunViewResult object will be populated.
+     */
+    ResultType?: 'simple' | 'entity_object' | 'count_only';
+};
+/**
+ * Class for running views in a generic, tier-independent manner - uses a provider model for
+ * implementation transparently from the viewpoint of the consumer of the class. By default the RunView class you create will
+ * connect to the DEFAULT provider. If you want your RunView to connect to a different provider, you can pass in the provider
+ * to the constructor.
+ */
+export declare class RunView {
+    private _provider;
+    /**
+     * Optionally, you can pass in a provider to the constructor. If you do not, the static RunView.Provider property is used.
+     * @param Provider
+     */
+    constructor(Provider?: IRunViewProvider | null);
+    /**
+     * This property is used to get the IRunViewProvider implementation that is used by this instance of the RunView class. If a provider was specified to the constructor, that provider is used, otherwise the static RunView.Provider property is used.
+     */
+    get ProviderToUse(): IRunViewProvider;
+    /**
+     * 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<T = any>(params: RunViewParams, contextUser?: UserInfo): Promise<RunViewResult<T>>;
+    /**
+     * Runs multiple views based on the provided parameters, see documentation for RunViewParams for more information
+     * @param params
+     * @param contextUser
+     * @returns
+     */
+    RunViews<T = any>(params: RunViewParams[], contextUser?: UserInfo): Promise<RunViewResult<T>[]>;
+    private static _globalProviderKey;
+    /**
+     * This is the static provider property that is used to get/set the IRunViewProvider implementation that is used by the RunView class.
+     * This property can be overridden on a per-instance basis by passing in the optional Provider parameter to the RunView constructor.
+     */
+    static get Provider(): IRunViewProvider;
+    static set Provider(value: IRunViewProvider);
+    /**
+     * Utility method that calculates the entity name for a given RunViewParams object by looking at the EntityName property as well as the ViewID/ViewName/ViewEntity properties as needed.
+     * @param params
+     * @returns
+     */
+    static GetEntityNameFromRunViewParams(params: RunViewParams, provider?: IMetadataProvider | null): Promise<string>;
+}
+//# sourceMappingURL=runView.d.ts.map

package/dist/views/runView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runView.d.ts","sourceRoot":"","sources":["../../src/views/runView.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAInD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,YAAY,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,SAAS,CAAiC;IAClD;;;OAGG;gBACS,QAAQ,GAAE,gBAAgB,GAAG,IAAW;IAIpD;;OAEG;IACH,IAAW,aAAa,IAAI,gBAAgB,CAE3C;IAED;;;;;OAKG;IACU,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAMvG;;;;;OAKG;IACU,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAM5G,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAgC;IACjE;;;OAGG;IACH,WAAkB,QAAQ,IAAI,gBAAgB,CAI7C;IACD,WAAkB,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAIjD;IAED;;;;OAIG;WACiB,8BAA8B,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,GAAE,iBAAiB,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,CAAC;CAqBtI"}

package/dist/views/runView.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunView = void 0;
+const Global_1 = require("../Global");
+/**
+ * Class for running views in a generic, tier-independent manner - uses a provider model for
+ * implementation transparently from the viewpoint of the consumer of the class. By default the RunView class you create will
+ * connect to the DEFAULT provider. If you want your RunView to connect to a different provider, you can pass in the provider
+ * to the constructor.
+ */
+class RunView {
+    /**
+     * Optionally, you can pass in a provider to the constructor. If you do not, the static RunView.Provider property is used.
+     * @param Provider
+     */
+    constructor(Provider = null) {
+        this._provider = null;
+        if (Provider)
+            this._provider = Provider;
+    }
+    /**
+     * This property is used to get the IRunViewProvider implementation that is used by this instance of the RunView class. If a provider was specified to the constructor, that provider is used, otherwise the static RunView.Provider property is used.
+     */
+    get ProviderToUse() {
+        return this._provider || RunView.Provider;
+    }
+    /**
+     * 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) {
+        // simple proxy to the provider, pre/post process moved to ProviderBase and called by each sub-class
+        // for validation and for optional transformation of the result
+        return await this.ProviderToUse.RunView(params, contextUser);
+    }
+    /**
+     * Runs multiple views based on the provided parameters, see documentation for RunViewParams for more information
+     * @param params
+     * @param contextUser
+     * @returns
+     */
+    async RunViews(params, contextUser) {
+        // same as RunView, a simple proxy to the provider, pre/post processes are moved to
+        // ProviderBase as with RunView
+        return this.ProviderToUse.RunViews(params, contextUser);
+    }
+    /**
+     * This is the static provider property that is used to get/set the IRunViewProvider implementation that is used by the RunView class.
+     * This property can be overridden on a per-instance basis by passing in the optional Provider parameter to the RunView constructor.
+     */
+    static get Provider() {
+        const g = 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 = 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');
+    }
+    /**
+     * Utility method that calculates the entity name for a given RunViewParams object by looking at the EntityName property as well as the ViewID/ViewName/ViewEntity properties as needed.
+     * @param params
+     * @returns
+     */
+    static async GetEntityNameFromRunViewParams(params, provider = null) {
+        const p = provider ? provider : RunView.Provider;
+        if (params.EntityName)
+            return params.EntityName;
+        else if (params.ViewEntity) {
+            const entityID = params.ViewEntity.Get('EntityID'); // using weak typing because this is MJCore and we don't want to use the sub-classes from core-entities as that would create a circular dependency
+            const entity = p.Entities.find((e) => e.ID === entityID);
+            if (entity)
+                return entity.Name;
+        }
+        else if (params.ViewID || params.ViewName) {
+            // we don't have a view entity loaded, so load it up now
+            const rv = new RunView(p);
+            const result = await rv.RunView({
+                EntityName: 'User Views',
+                ExtraFilter: params.ViewID ? `ID = '${params.ViewID}'` : `Name = '${params.ViewName}'`,
+                ResultType: 'entity_object',
+            });
+            if (result && result.Success && result.Results.length > 0) {
+                return result.Results[0].Entity; // virtual field in the User Views entity called Entity
+            }
+        }
+        else
+            return null;
+    }
+}
+exports.RunView = RunView;
+RunView._globalProviderKey = 'MJ_RunViewProvider';
+//# 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":";;;AAIA,sCAAqC;AAyGrC;;;;;GAKG;AACH,MAAa,OAAO;IAElB;;;OAGG;IACH,YAAY,WAAoC,IAAI;QAL5C,cAAS,GAA4B,IAAI,CAAC;QAMhD,IAAI,QAAQ;YAAE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAU,MAAqB,EAAE,WAAsB;QACzE,oGAAoG;QACpG,+DAA+D;QAC/D,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAI,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAU,MAAuB,EAAE,WAAsB;QAC5E,mFAAmF;QACnF,+BAA+B;QAC/B,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IAGD;;;OAGG;IACI,MAAM,KAAK,QAAQ;QACxB,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;;YACvC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;IACM,MAAM,KAAK,QAAQ,CAAC,KAAuB;QAChD,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;;YACxC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,MAAqB,EAAE,WAAqC,IAAI;QACjH,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAA0B,OAAO,CAAC,QAAS,CAAC;QAE3E,IAAI,MAAM,CAAC,UAAU;YAAE,OAAO,MAAM,CAAC,UAAU,CAAC;aAC3C,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,kJAAkJ;YACtM,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;YACzD,IAAI,MAAM;gBAAE,OAAO,MAAM,CAAC,IAAI,CAAC;QACjC,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,wDAAwD;YACxD,MAAM,EAAE,GAAG,IAAI,OAAO,CAAyB,CAAE,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;gBAC9B,UAAU,EAAE,YAAY;gBACxB,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,MAAM,CAAC,QAAQ,GAAG;gBACtF,UAAU,EAAE,eAAe;aAC5B,CAAC,CAAC;YACH,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1D,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,uDAAuD;YAC1F,CAAC;QACH,CAAC;;YAAM,OAAO,IAAI,CAAC;IACrB,CAAC;;AAlFH,0BAmFC;AA1CgB,0BAAkB,GAAW,oBAAoB,AAA/B,CAAgC"}