@cellaware/utils 8.2.2 → 8.3.0

package/dist/chatwms/cosmos.d.ts

@@ -0,0 +1,24 @@
+import { DatagridCondition } from "./datagrid.js";
+import { SqlCacheContext } from "./developer.js";
+export interface CosmosVariable {
+    key: string;
+    value: any;
+}
+export declare function createCosmosVariables(userId: string): CosmosVariable[];
+export declare function loadCosmosDeveloperCache(userId: string): SqlCacheContext;
+export interface CosmosQuery {
+    table: string;
+    query: string;
+}
+export interface CosmosQueryContext {
+    customer?: string;
+    organization?: string;
+    warehouse?: string;
+}
+/**
+ * Extracts the first word after the `FROM` and replaces it with the necessary contents based on the context.
+ *
+ * Returns the adjusted query and the extracted lowercase table name.
+ */
+export declare function createCosmosQuery(query: string, variables: CosmosVariable[], context?: CosmosQueryContext): CosmosQuery;
+export declare function executeCosmosQuery(cosmosQuery: CosmosQuery, parameters: DatagridCondition[], rowLimit?: number): Promise<any[]>;

package/dist/chatwms/cosmos.js

@@ -0,0 +1,508 @@
+import { getQueryMatches } from "../util.js";
+import { chatwmsCosmosSelect } from "./azure/cosmos.js";
+import { COSMOS_CONTEXT_NAME, chatwmsGetClientId } from "./client.js";
+import { codifyCondition } from "./datagrid.js";
+const COSMOS_SQL_ACTION_WORDS_REGEX = /\b(insert|update|delete|create|alter|drop|commit|rollback)\b/gmi;
+const COSMOS_SQL_SELECT_REGEX = /\b(select)\b/gmi;
+const COSMOS_SQL_FROM_REGEX = /\b(from)\b/gmi;
+const COSMOS_SQL_WHERE_REGEX = /\b(where)\b/gmi;
+const COSMOS_SQL_APPROVED_TABLES_REGEX = /\b(alert_executions|alert_subscriptions|alerts|client_configs|conversation_details|conversation_feedback|conversation_headers|conversation_metadata|conversation_removed_details|conversation_sampled_details|conversation_sampled_metadata|dashboard_usage|dashboard_widgets|dashboards|notifications|report_lines|report_usage|reports|user_roles)\b/gmi;
+const _SUBQUERY_QUERY_PLACEHOLDER_UNWRAPPED = '{{query}}';
+const SUBQUERY_QUERY_PLACEHOLDER = `(${_SUBQUERY_QUERY_PLACEHOLDER_UNWRAPPED})`;
+const VARIABLE_COSMOS_USER_ID = '__USER_ID__';
+const VARIABLE_COSMOS_CURRENT_DAY = '__CURRENT_DAY__';
+const VARIABLE_COSMOS_CURRENT_MONTH = '__CURRENT_MONTH__';
+const VARIABLE_COSMOS_CURRENT_YEAR = '__CURRENT_YEAR__';
+const VARIABLE_COSMOS_CURRENT_DAY_NAME = '__CURRENT_DAY_NAME__';
+const VARIABLE_COSMOS_CURRENT_DAY_FULL_NAME = '__CURRENT_DAY_FULL_NAME__';
+const VARIABLE_COSMOS_CURRENT_MONTH_NAME = '__CURRENT_MONTH_NAME__';
+const VARIABLE_COSMOS_CURRENT_MONTH_FULL_NAME = '__CURRENT_MONTH_FULL_NAME__';
+const VARIABLE_COSMOS_TIMESTAMP_DAY = '__TIMESTAMP_DAY__';
+const VARIABLE_COSMOS_TIMESTAMP_MONTH = '__TIMESTAMP_MONTH__';
+const VARIABLE_COSMOS_TIMESTAMP_YEAR = '__TIMESTAMP_YEAR__';
+const VARIABLE_COSMOS_TIMESTAMP_DAY_NAME = '__TIMESTAMP_DAY_NAME__';
+const VARIABLE_COSMOS_TIMESTAMP_DAY_FULL_NAME = '__TIMESTAMP_DAY_FULL_NAME__';
+const VARIABLE_COSMOS_TIMESTAMP_MONTH_NAME = '__TIMESTAMP_MONTH_NAME__';
+const VARIABLE_COSMOS_TIMESTAMP_MONTH_FULL_NAME = '__TIMESTAMP_MONTH_FULL_NAME__';
+const VARIABLE_COSMOS_LAST_14_DAYS_CLAUSE = '__LAST_14_DAYS_CLAUSE__';
+const VARIABLE_COSMOS_LAST_30_DAYS_CLAUSE = '__LAST_30_DAYS_CLAUSE__';
+const VARIABLE_COSMOS_LAST_90_DAYS_CLAUSE = '__LAST_90_DAYS_CLAUSE__';
+const VARIABLE_COSMOS_LAST_180_DAYS_CLAUSE = '__LAST_180_DAYS_CLAUSE__';
+const VARIABLE_COSMOS_LAST_365_DAYS_CLAUSE = '__LAST_365_DAYS_CLAUSE__';
+const VARIABLE_COSMOS_CURRENT_DAY_CLAUSE = '__CURRENT_DAY_CLAUSE__';
+const VARIABLE_COSMOS_CURRENT_MONTH_CLAUSE = '__CURRENT_MONTH_CLAUSE__';
+const VARIABLE_COSMOS_CURRENT_YEAR_CLAUSE = '__CURRENT_YEAR_CLAUSE__';
+const COSMOS_DATE_VARIABLES = [
+    // CURRENT:
+    { key: VARIABLE_COSMOS_CURRENT_DAY, value: 'DateTimePart("day", GetCurrentDateTime())' },
+    { key: VARIABLE_COSMOS_CURRENT_MONTH, value: 'DateTimePart("month", GetCurrentDateTime())' },
+    { key: VARIABLE_COSMOS_CURRENT_YEAR, value: 'DateTimePart("year", GetCurrentDateTime())' },
+    { key: VARIABLE_COSMOS_CURRENT_DAY_NAME, value: 'IIF(DateTimePart("weekday", GetCurrentDateTime()) = 0, "Sun", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 1, "Mon", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 2, "Tue", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 3, "Wed", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 4, "Thu", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 5, "Fri", "Sat"))))))' },
+    { key: VARIABLE_COSMOS_CURRENT_DAY_FULL_NAME, value: 'IIF(DateTimePart("weekday", GetCurrentDateTime()) = 0, "Sunday", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 1, "Monday", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 2, "Tuesday", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 3, "Wednesday", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 4, "Thursday", IIF(DateTimePart("weekday", GetCurrentDateTime()) = 5, "Friday", "Saturday"))))))' },
+    { key: VARIABLE_COSMOS_CURRENT_MONTH_NAME, value: 'IIF(DateTimePart("month", GetCurrentDateTime()) = 1, "Jan", IIF(DateTimePart("month", GetCurrentDateTime()) = 2, "Feb", IIF(DateTimePart("month", GetCurrentDateTime()) = 3, "Mar", IIF(DateTimePart("month", GetCurrentDateTime()) = 4, "Apr", IIF(DateTimePart("month", GetCurrentDateTime()) = 5, "May", IIF(DateTimePart("month", GetCurrentDateTime()) = 6, "Jun", IIF(DateTimePart("month", GetCurrentDateTime()) = 7, "Jul", IIF(DateTimePart("month", GetCurrentDateTime()) = 8, "Aug", IIF(DateTimePart("month", GetCurrentDateTime()) = 9, "Sep", IIF(DateTimePart("month", GetCurrentDateTime()) = 10, "Oct", IIF(DateTimePart("month", GetCurrentDateTime()) = 11, "Nov", IIF(DateTimePart("month", GetCurrentDateTime()) = 12, "Dec", "N/A"))))))))))))' },
+    { key: VARIABLE_COSMOS_CURRENT_MONTH_FULL_NAME, value: 'IIF(DateTimePart("month", GetCurrentDateTime()) = 1, "January", IIF(DateTimePart("month", GetCurrentDateTime()) = 2, "February", IIF(DateTimePart("month", GetCurrentDateTime()) = 3, "March", IIF(DateTimePart("month", GetCurrentDateTime()) = 4, "April", IIF(DateTimePart("month", GetCurrentDateTime()) = 5, "May", IIF(DateTimePart("month", GetCurrentDateTime()) = 6, "June", IIF(DateTimePart("month", GetCurrentDateTime()) = 7, "July", IIF(DateTimePart("month", GetCurrentDateTime()) = 8, "August", IIF(DateTimePart("month", GetCurrentDateTime()) = 9, "September", IIF(DateTimePart("month", GetCurrentDateTime()) = 10, "October", IIF(DateTimePart("month", GetCurrentDateTime()) = 11, "November", IIF(DateTimePart("month", GetCurrentDateTime()) = 12, "December", "N/A"))))))))))))' },
+    // TIMESTAMP:
+    { key: VARIABLE_COSMOS_TIMESTAMP_DAY, value: 'DateTimePart("day", TimestampToDateTime(c._ts * 1000))' },
+    { key: VARIABLE_COSMOS_TIMESTAMP_MONTH, value: 'DateTimePart("month", TimestampToDateTime(c._ts * 1000))' },
+    { key: VARIABLE_COSMOS_TIMESTAMP_YEAR, value: 'DateTimePart("year", TimestampToDateTime(c._ts * 1000))' },
+    { key: VARIABLE_COSMOS_TIMESTAMP_DAY_NAME, value: 'IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 0, "Sun", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 1, "Mon", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 2, "Tue", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 3, "Wed", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 4, "Thu", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 5, "Fri", "Sat"))))))' },
+    { key: VARIABLE_COSMOS_TIMESTAMP_DAY_FULL_NAME, value: 'IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 0, "Sunday", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 1, "Monday", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 2, "Tuesday", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 3, "Wednesday", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 4, "Thursday", IIF(DateTimePart("weekday", TimestampToDateTime(c._ts * 1000)) = 5, "Friday", "Saturday"))))))' },
+    { key: VARIABLE_COSMOS_TIMESTAMP_MONTH_NAME, value: 'IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 1, "Jan", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 2, "Feb", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 3, "Mar", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 4, "Apr", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 5, "May", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 6, "Jun", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 7, "Jul", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 8, "Aug", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 9, "Sep", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 10, "Oct", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 11, "Nov", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 12, "Dec", "N/A"))))))))))))' },
+    { key: VARIABLE_COSMOS_TIMESTAMP_MONTH_FULL_NAME, value: 'IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 1, "January", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 2, "February", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 3, "March", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 4, "April", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 5, "May", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 6, "June", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 7, "July", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 8, "August", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 9, "September", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 10, "October", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 11, "November", IIF(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = 12, "December", "N/A"))))))))))))' },
+    // CLAUSE:
+    { key: VARIABLE_COSMOS_LAST_14_DAYS_CLAUSE, value: 'c._ts >= ((GetCurrentTimestamp() / 1000) - 14 * 24 * 60 * 60)' },
+    { key: VARIABLE_COSMOS_LAST_30_DAYS_CLAUSE, value: 'c._ts >= ((GetCurrentTimestamp() / 1000) - 30 * 24 * 60 * 60)' },
+    { key: VARIABLE_COSMOS_LAST_90_DAYS_CLAUSE, value: 'c._ts >= ((GetCurrentTimestamp() / 1000) - 90 * 24 * 60 * 60)' },
+    { key: VARIABLE_COSMOS_LAST_180_DAYS_CLAUSE, value: 'c._ts >= ((GetCurrentTimestamp() / 1000) - 180 * 24 * 60 * 60)' },
+    { key: VARIABLE_COSMOS_LAST_365_DAYS_CLAUSE, value: 'c._ts >= ((GetCurrentTimestamp() / 1000) - 365 * 24 * 60 * 60)' },
+    { key: VARIABLE_COSMOS_CURRENT_DAY_CLAUSE, value: '(DateTimePart("day", TimestampToDateTime(c._ts * 1000)) = DateTimePart("day", GetCurrentDateTime()) AND DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = DateTimePart("month", GetCurrentDateTime()) AND DateTimePart("year", TimestampToDateTime(c._ts * 1000)) = DateTimePart("year", GetCurrentDateTime()))' },
+    { key: VARIABLE_COSMOS_CURRENT_MONTH_CLAUSE, value: '(DateTimePart("month", TimestampToDateTime(c._ts * 1000)) = DateTimePart("month", GetCurrentDateTime()) AND DateTimePart("year", TimestampToDateTime(c._ts * 1000)) = DateTimePart("year", GetCurrentDateTime()))' },
+    { key: VARIABLE_COSMOS_CURRENT_YEAR_CLAUSE, value: 'DateTimePart("year", TimestampToDateTime(c._ts * 1000)) = DateTimePart("year", GetCurrentDateTime())' }
+];
+const COSMOS_TABLES = [
+    {
+        table_name: 'alert_executions',
+        table_description: 'Alert Executions'
+    },
+    {
+        table_name: 'alert_subscriptions',
+        table_description: 'Alert Subscriptions'
+    },
+    {
+        table_name: 'alerts',
+        table_description: 'Alerts'
+    },
+    {
+        table_name: 'client_configs',
+        table_description: 'Client Configurations'
+    },
+    {
+        table_name: 'conversation_details',
+        table_description: 'Conversation Details'
+    },
+    {
+        table_name: 'conversation_feedback',
+        table_description: 'Conversation Feedback'
+    },
+    {
+        table_name: 'conversation_headers',
+        table_description: 'Conversation Headers'
+    },
+    {
+        table_name: 'conversation_metadata',
+        table_description: 'Conversation Metadata'
+    },
+    {
+        table_name: 'conversation_removed_details',
+        table_description: 'Conversation Removed Details'
+    },
+    {
+        table_name: 'conversation_sampled_details',
+        table_description: 'Conversation Sampled Details'
+    },
+    {
+        table_name: 'conversation_sampled_metadata',
+        table_description: 'Conversation Sampled Metadata'
+    },
+    {
+        table_name: 'dashboard_usage',
+        table_description: 'Dashboard Usage'
+    },
+    {
+        table_name: 'dashboard_widgets',
+        table_description: 'Dashboard Widgets'
+    },
+    {
+        table_name: 'dashboards',
+        table_description: 'Dashboards'
+    },
+    {
+        table_name: 'notifications',
+        table_description: 'Notifications'
+    },
+    {
+        table_name: 'report_lines',
+        table_description: 'Report Lines'
+    },
+    {
+        table_name: 'report_usage',
+        table_description: 'Report Usage'
+    },
+    {
+        table_name: 'reports',
+        table_description: 'Reports'
+    },
+    {
+        table_name: 'user_roles',
+        table_description: 'User Roles'
+    }
+];
+const COSMOS_FUNCTIONS = initCosmosFunctions();
+function initCosmosFunctions() {
+    const functions = [];
+    const initFn = (name, type, args, description) => {
+        return {
+            name,
+            type,
+            args,
+            description
+        };
+    };
+    // https://learn.microsoft.com/en-us/cosmos-db/query/functions
+    // MATHEMATICAL FUNCTIONS:
+    functions.push(initFn('abs', 'math', ['value'], 'Returns the absolute value of a numeric expression.'));
+    functions.push(initFn('acos', 'math', ['value'], 'Returns the arccosine of a numeric value, in radians.'));
+    functions.push(initFn('asin', 'math', ['value'], 'Returns the arcsine of a numeric value, in radians.'));
+    functions.push(initFn('atan', 'math', ['value'], 'Returns the arctangent of a numeric value, in radians.'));
+    functions.push(initFn('atn2', 'math', ['y', 'x'], 'Returns the arctangent of y/x, in radians.'));
+    functions.push(initFn('ceiling', 'math', ['value'], 'Returns the smallest integer greater than or equal to the value.'));
+    functions.push(initFn('cos', 'math', ['radians'], 'Returns the cosine of an angle in radians.'));
+    functions.push(initFn('cot', 'math', ['radians'], 'Returns the cotangent of an angle in radians.'));
+    functions.push(initFn('degrees', 'math', ['radians'], 'Converts an angle from radians to degrees.'));
+    functions.push(initFn('exp', 'math', ['value'], 'Returns e raised to the given numeric value.'));
+    functions.push(initFn('floor', 'math', ['value'], 'Returns the largest integer less than or equal to the value.'));
+    functions.push(initFn('intadd', 'math', ['a', 'b'], 'Adds two integer values.'));
+    functions.push(initFn('intbitand', 'math', ['a', 'b'], 'Performs a bitwise AND on two integer values.'));
+    functions.push(initFn('intbitleftshift', 'math', ['value', 'shift'], 'Performs a bitwise left shift on an integer value.'));
+    functions.push(initFn('intbitnot', 'math', ['value'], 'Performs a bitwise NOT on an integer value.'));
+    functions.push(initFn('intbitor', 'math', ['a', 'b'], 'Performs a bitwise OR on two integer values.'));
+    functions.push(initFn('intbitrightshift', 'math', ['value', 'shift'], 'Performs a bitwise right shift on an integer value.'));
+    functions.push(initFn('intbitxor', 'math', ['a', 'b'], 'Performs a bitwise XOR on two integer values.'));
+    functions.push(initFn('intdiv', 'math', ['a', 'b'], 'Divides one integer by another and returns the integer result.'));
+    functions.push(initFn('intmod', 'math', ['a', 'b'], 'Returns the remainder from integer division.'));
+    functions.push(initFn('intmul', 'math', ['a', 'b'], 'Multiplies two integer values.'));
+    functions.push(initFn('intsub', 'math', ['a', 'b'], 'Subtracts one integer value from another.'));
+    functions.push(initFn('log', 'math', ['value'], 'Returns the natural logarithm of a numeric expression.'));
+    functions.push(initFn('log10', 'math', ['value'], 'Returns the base-10 logarithm of a numeric expression.'));
+    functions.push(initFn('numberbin', 'math', ['value', 'size'], 'Bins or rounds a number to a multiple of the given size.'));
+    functions.push(initFn('pi', 'math', [], 'Returns the constant value of π.'));
+    functions.push(initFn('power', 'math', ['value', 'exponent'], 'Returns a value raised to the specified power.'));
+    functions.push(initFn('radians', 'math', ['degrees'], 'Converts an angle from degrees to radians.'));
+    functions.push(initFn('rand', 'math', [], 'Returns a random float between 0 and 1.'));
+    functions.push(initFn('round', 'math', ['value'], 'Rounds a numeric value to the nearest integer.'));
+    functions.push(initFn('sign', 'math', ['value'], 'Returns -1, 0, or 1 depending on the sign of the value.'));
+    functions.push(initFn('sin', 'math', ['radians'], 'Returns the sine of an angle in radians.'));
+    functions.push(initFn('sqrt', 'math', ['value'], 'Returns the square root of a numeric value.'));
+    functions.push(initFn('square', 'math', ['value'], 'Returns a numeric value squared.'));
+    functions.push(initFn('tan', 'math', ['radians'], 'Returns the tangent of an angle in radians.'));
+    functions.push(initFn('trunc', 'math', ['value'], 'Truncates a numeric value to its integer part.'));
+    // ARRAY FUNCTIONS:
+    functions.push(initFn('array_concat', 'array', ['...arrays'], 'Concatenates two or more arrays into a single array.'));
+    functions.push(initFn('array_contains_all', 'array', ['array', 'values'], 'Returns true if the array contains all specified values.'));
+    functions.push(initFn('array_contains_any', 'array', ['array', 'values'], 'Returns true if the array contains any of the specified values.'));
+    functions.push(initFn('array_contains', 'array', ['array', 'value'], 'Returns true if the array contains the specified value.'));
+    functions.push(initFn('array_length', 'array', ['array'], 'Returns the number of elements in an array.'));
+    functions.push(initFn('array_slice', 'array', ['array', 'start', 'length'], 'Returns a subset of an array.'));
+    functions.push(initFn('choose', 'array', ['index', '...values'], 'Returns the expression at the specified index from a list.'));
+    functions.push(initFn('objecttoarray', 'array', ['object'], 'Converts a JSON object’s fields to an array of key/value pairs.'));
+    functions.push(initFn('setintersect', 'array', ['array1', 'array2'], 'Returns the set of values present in both arrays (no duplicates).'));
+    functions.push(initFn('setunion', 'array', ['array1', 'array2'], 'Returns the union of values from two arrays (no duplicates).'));
+    // AGGREGATION FUNCTIONS:
+    functions.push(initFn('avg', 'aggregate', ['expression'], 'Returns the average of the values in an expression.'));
+    functions.push(initFn('count', 'aggregate', ['expression'], 'Returns the number of values in an expression.'));
+    functions.push(initFn('max', 'aggregate', ['expression'], 'Returns the maximum value of an expression.'));
+    functions.push(initFn('min', 'aggregate', ['expression'], 'Returns the minimum value of an expression.'));
+    functions.push(initFn('sum', 'aggregate', ['expression'], 'Returns the sum of the values in an expression.'));
+    // STRING FUNCTIONS:
+    functions.push(initFn('concat', 'string', ['...strings'], 'Concatenates multiple string expressions.'));
+    functions.push(initFn('contains', 'string', ['source', 'value', 'caseSensitive?'], 'Returns true if the first string contains the second.'));
+    functions.push(initFn('endswith', 'string', ['source', 'suffix', 'caseSensitive?'], 'Returns true if a string ends with the specified suffix.'));
+    functions.push(initFn('index_of', 'string', ['source', 'search', 'start?'], 'Returns the index of the first occurrence of a substring.'));
+    functions.push(initFn('left', 'string', ['source', 'length'], 'Returns the leftmost characters of a string.'));
+    functions.push(initFn('length', 'string', ['source'], 'Returns the number of characters in a string.'));
+    functions.push(initFn('lower', 'string', ['source'], 'Converts a string to lowercase.'));
+    functions.push(initFn('ltrim', 'string', ['source', 'trimChars?'], 'Trims leading whitespace or specified characters from a string.'));
+    functions.push(initFn('regexmatch', 'string', ['source', 'pattern'], 'Returns true if the string matches the given regular expression.'));
+    functions.push(initFn('replace', 'string', ['source', 'search', 'replace'], 'Replaces all occurrences of a substring with another string.'));
+    functions.push(initFn('replicate', 'string', ['source', 'count'], 'Repeats a string a given number of times.'));
+    functions.push(initFn('reverse', 'string', ['source'], 'Returns the characters of a string in reverse order.'));
+    functions.push(initFn('right', 'string', ['source', 'length'], 'Returns the rightmost characters of a string.'));
+    functions.push(initFn('rtrim', 'string', ['source', 'trimChars?'], 'Trims trailing whitespace or specified characters from a string.'));
+    functions.push(initFn('startswith', 'string', ['source', 'prefix', 'caseSensitive?'], 'Returns true if the string starts with the specified prefix.'));
+    functions.push(initFn('stringequals', 'string', ['a', 'b', 'caseSensitive?'], 'Returns true if two strings are equal.'));
+    functions.push(initFn('stringjoin', 'string', ['separator', 'array'], 'Joins an array of strings with a separator.'));
+    functions.push(initFn('stringsplit', 'string', ['source', 'delimiter'], 'Splits a string into an array using the delimiter.'));
+    functions.push(initFn('stringtoarray', 'string', ['source'], 'Converts a string to an array.'));
+    functions.push(initFn('stringtoboolean', 'string', ['source'], 'Converts a string to a boolean.'));
+    functions.push(initFn('substring', 'string', ['source', 'start', 'length?'], 'Returns a substring starting at the given position.'));
+    functions.push(initFn('tostring', 'string', ['value'], 'Converts a value to its string representation.'));
+    functions.push(initFn('trim', 'string', ['source', 'trimChars?'], 'Trims leading and trailing whitespace or characters.'));
+    functions.push(initFn('upper', 'string', ['source'], 'Converts a string to uppercase.'));
+    // DATE AND TIME FUNCTIONS:
+    functions.push(initFn('datetimeadd', 'date', ['dateTime', 'part', 'amount'], 'Adds an interval to a date and time string.'));
+    functions.push(initFn('datetimebin', 'date', ['dateTime', 'part', 'size'], 'Bins or rounds a date and time to the given granularity.'));
+    functions.push(initFn('datetimediff', 'date', ['part', 'start', 'end'], 'Returns the difference between two dates for the specified part.'));
+    functions.push(initFn('datetimefromparts', 'date', ['year', 'month', 'day', 'hour', 'minute', 'second', 'fraction?'], 'Builds a date and time string from individual parts.'));
+    functions.push(initFn('datetimepart', 'date', ['part', 'dateTime'], 'Returns the value of the specified date/time part.'));
+    functions.push(initFn('datetimetoticks', 'date', ['dateTime'], 'Converts a date/time string to ticks.'));
+    functions.push(initFn('datetimetotimestamp', 'date', ['dateTime'], 'Converts a date/time string to a Unix timestamp (ms).'));
+    functions.push(initFn('getcurrentdatetime', 'date', [], 'Returns the current UTC date and time as an ISO 8601 string.'));
+    functions.push(initFn('getcurrentdatetimestatic', 'date', [], 'Returns a fixed UTC date and time for all items in the query.'));
+    functions.push(initFn('getcurrentticks', 'date', [], 'Returns the current UTC time in ticks.'));
+    functions.push(initFn('getcurrentticksstatic', 'date', [], 'Returns a static tick value for all items in the same partition.'));
+    functions.push(initFn('getcurrenttimestamp', 'date', [], 'Returns the current Unix timestamp in milliseconds.'));
+    functions.push(initFn('getcurrenttimestampstatic', 'date', [], 'Returns a static Unix timestamp for all items in the same partition.'));
+    functions.push(initFn('tickstodatetime', 'date', ['ticks'], 'Converts ticks to a date and time string.'));
+    functions.push(initFn('timestamptodatetime', 'date', ['timestamp'], 'Converts a Unix timestamp to a date and time string.'));
+    // ITEM FUNCTIONS:
+    functions.push(initFn('documentid', 'item', ['item'], 'Returns the unique document ID for an item.'));
+    // FULL TEXT SEARCH FUNCTIONS:
+    functions.push(initFn('fulltextcontains', 'fulltext', ['path', 'keyword'], 'Returns true if the keyword is contained in the specified property path.'));
+    functions.push(initFn('fulltextcontainsall', 'fulltext', ['path', '...keywords'], 'Returns true if all keywords are contained in the property path.'));
+    functions.push(initFn('fulltextcontainsany', 'fulltext', ['path', '...keywords'], 'Returns true if any keywords are contained in the property path.'));
+    functions.push(initFn('fulltextscore', 'fulltext', ['path', 'keyword'], 'Returns a relevance score that can be used with ORDER BY RANK.'));
+    functions.push(initFn('rrf', 'fulltext', ['...scores'], 'Combines multiple scores into a fused ranking value.'));
+    // CONDITIONAL FUNCTIONS:
+    functions.push(initFn('iif', 'conditional', ['condition', 'trueValue', 'falseValue'], 'Returns one of two values depending on a boolean expression.'));
+    // TYPE CHECKING / CONVERSION FUNCTIONS:
+    functions.push(initFn('is_array', 'type', ['expression'], 'Returns true if the expression is an array.'));
+    functions.push(initFn('is_bool', 'type', ['expression'], 'Returns true if the expression is a boolean.'));
+    functions.push(initFn('is_defined', 'type', ['expression'], 'Returns true if the property has a defined value.'));
+    functions.push(initFn('is_finite_number', 'type', ['expression'], 'Returns true if the expression is a finite number.'));
+    functions.push(initFn('is_integer', 'type', ['expression'], 'Returns true if the expression is a 64-bit signed integer.'));
+    functions.push(initFn('is_null', 'type', ['expression'], 'Returns true if the expression is null.'));
+    functions.push(initFn('is_number', 'type', ['expression'], 'Returns true if the expression is a number.'));
+    functions.push(initFn('is_object', 'type', ['expression'], 'Returns true if the expression is a JSON object.'));
+    functions.push(initFn('is_primitive', 'type', ['expression'], 'Returns true if the expression is a primitive value.'));
+    functions.push(initFn('is_string', 'type', ['expression'], 'Returns true if the expression is a string.'));
+    functions.push(initFn('stringtonull', 'type', ['source'], 'Converts a string expression to null.'));
+    functions.push(initFn('stringtonumber', 'type', ['source'], 'Converts a string expression to a number.'));
+    functions.push(initFn('stringtoobject', 'type', ['source'], 'Converts a string expression to an object.'));
+    // SPATIAL / VECTOR FUNCTIONS:
+    functions.push(initFn('st_area', 'spatial', ['geometry'], 'Returns the area of a GeoJSON Polygon or MultiPolygon.'));
+    functions.push(initFn('st_distance', 'spatial', ['geometry1', 'geometry2'], 'Returns the distance between two GeoJSON geometries.'));
+    functions.push(initFn('st_intersects', 'spatial', ['geometry1', 'geometry2'], 'Returns true if two GeoJSON geometries intersect.'));
+    functions.push(initFn('st_isvalid', 'spatial', ['geometry'], 'Returns true if the GeoJSON geometry is valid.'));
+    functions.push(initFn('st_isvaliddetailed', 'spatial', ['geometry'], 'Returns validity information and reason for an invalid geometry.'));
+    functions.push(initFn('st_within', 'spatial', ['geometry1', 'geometry2'], 'Returns true if the first GeoJSON geometry is within the second.'));
+    functions.push(initFn('vectordistance', 'spatial', ['vector1', 'vector2'], 'Returns a similarity or distance score between two vectors.'));
+    return functions;
+}
+export function createCosmosVariables(userId) {
+    return [
+        { key: VARIABLE_COSMOS_USER_ID, value: `'${userId}'` },
+        ...COSMOS_DATE_VARIABLES
+    ];
+}
+export function loadCosmosDeveloperCache(userId) {
+    return {
+        contextName: COSMOS_CONTEXT_NAME,
+        variables: createCosmosVariables(userId),
+        tables: COSMOS_TABLES,
+        columns: [],
+        functions: COSMOS_FUNCTIONS,
+        tableMappings: [],
+        columnMappings: []
+    };
+}
+/**
+ * The `subquery` **must** contain `({{query}})` placeholder inside of it.
+ *
+ * The transformed query will be injected in the place of the **first** `{{query}}`.
+ */
+function injectSubquery(query, subquery) {
+    // NOTE: we do not need to worry about semicolons or common table expressions -- these are not allowed in Cosmos.
+    if (!subquery.includes(SUBQUERY_QUERY_PLACEHOLDER)) {
+        throw new Error(`Subquery must contain '${SUBQUERY_QUERY_PLACEHOLDER}' placeholder.`);
+    }
+    let queryMut = query.trim();
+    queryMut = subquery.replace(_SUBQUERY_QUERY_PLACEHOLDER_UNWRAPPED, queryMut);
+    return queryMut;
+}
+function injectParameters(query, parameters) {
+    // NOTE: we do not need to worry about semicolons or common table expressions -- these are not allowed in Cosmos.
+    let queryMut = query.trim();
+    if (parameters.length > 0) {
+        let whereBuf = '1 = 1';
+        for (const parameter of parameters) {
+            whereBuf += ` AND ${codifyCondition(parameter)}`;
+        }
+        const subquery = `SELECT * FROM ${SUBQUERY_QUERY_PLACEHOLDER} param_sq WHERE ${whereBuf}`;
+        queryMut = injectSubquery(queryMut, subquery);
+    }
+    return queryMut;
+}
+/** Substitutes instances of Cosmos variables with their respective values. */
+function injectCosmosVariables(query, variables) {
+    let queryMut = query;
+    if (!!variables) {
+        for (const variable of variables) {
+            queryMut = queryMut.replaceAll(variable.key, variable.value);
+        }
+    }
+    return queryMut;
+}
+/**
+ * Extracts the first word after the `FROM` and replaces it with the necessary contents based on the context.
+ *
+ * Returns the adjusted query and the extracted lowercase table name.
+ */
+export function createCosmosQuery(query, variables, context) {
+    // Validate query:
+    {
+        // Query must not contain any action words.
+        const actionMatches = getQueryMatches(query, COSMOS_SQL_ACTION_WORDS_REGEX);
+        if (actionMatches.length > 0) {
+            throw new Error(`Cannot execute action query`);
+        }
+        // Query must not have more than 1 `SELECT`, `FROM`, or `WHERE`.
+        const selectMatches = getQueryMatches(query, COSMOS_SQL_SELECT_REGEX);
+        if (selectMatches.length > 1) {
+            throw new Error(`Multiple queries or subqueries are not allowed`);
+        }
+        const fromMatches = getQueryMatches(query, COSMOS_SQL_FROM_REGEX);
+        if (fromMatches.length > 1) {
+            throw new Error(`Multiple queries or subqueries are not allowed`);
+        }
+        const whereMatches = getQueryMatches(query, COSMOS_SQL_WHERE_REGEX);
+        if (whereMatches.length > 1) {
+            throw new Error(`Multiple queries or subqueries are not allowed`);
+        }
+        const tableMatches = getQueryMatches(query, COSMOS_SQL_APPROVED_TABLES_REGEX);
+        if (tableMatches.length === 0) {
+            throw new Error(`Must only query approved tables`);
+        }
+        else if (tableMatches.length > 1) {
+            throw new Error(`Multiple queries or subqueries are not allowed`);
+        }
+    }
+    let table = '';
+    let hasAs = !!query.match(/FROM\s+([A-Za-z0-9_]+)\s+(AS)/gmi);
+    let queryMut = query.replace(/FROM\s+([A-Za-z0-9_]+)/gmi, (match, matchedTable) => {
+        table = matchedTable;
+        // NOTE: we will never have `organization` or `warehouse` without `customer`.
+        if (!!context && !!context.customer) {
+            let whereClause = '';
+            if (!!context.warehouse) {
+                if (table === 'user_roles') {
+                    whereClause = `WHERE c.customer = '${context.customer}' AND c.warehouse = '${context.warehouse}'`;
+                }
+                else {
+                    whereClause = `WHERE c.clientId = '${chatwmsGetClientId(context.customer, context.warehouse)}'`;
+                }
+            }
+            else if (!!context.organization) {
+                if (table === 'user_roles') {
+                    whereClause = `WHERE c.customer = '${context.customer}' AND c.warehouse LIKE '${context.organization}_%'`;
+                }
+                else {
+                    whereClause = `WHERE c.clientId LIKE '${context.customer}_${context.organization}_%'`;
+                }
+            }
+            else {
+                if (table === 'user_roles') {
+                    whereClause = `WHERE c.customer = '${context.customer}'`;
+                }
+                else {
+                    whereClause = `WHERE c.clientId LIKE '${context.customer}_%'`;
+                }
+            }
+            return `FROM (SELECT * FROM c ${whereClause})${hasAs ? '' : ' AS c'}`;
+        }
+        else {
+            return 'FROM c';
+        }
+    });
+    if (table === '') {
+        throw new Error(`No table detected in COSMOS query: ${query}`);
+    }
+    queryMut = injectCosmosVariables(queryMut, variables);
+    return { table: table.toLowerCase(), query: queryMut };
+}
+async function getUserDetails() {
+    let map = new Map();
+    (await chatwmsCosmosSelect('user_settings', 'SELECT DISTINCT c.userId, c.userDetails FROM c ORDER BY c.userId')).map(user => {
+        map.set(user.userId, user.userDetails);
+    });
+    return map;
+}
+async function getClientDescriptions() {
+    let map = new Map();
+    (await chatwmsCosmosSelect('client_configs', 'SELECT DISTINCT c.clientId, c.description FROM c ORDER BY c.clientId')).map(client => {
+        map.set(client.clientId, client.description);
+    });
+    return map;
+}
+async function getDashboardTitles() {
+    let map = new Map();
+    (await chatwmsCosmosSelect('dashboards', 'SELECT DISTINCT c.dashboardId, c.dashboardTitle FROM c ORDER BY c.dashboardId')).map(dashboard => {
+        map.set(dashboard.dashboardId, dashboard.dashboardTitle);
+    });
+    return map;
+}
+async function getReportTitles() {
+    let map = new Map();
+    (await chatwmsCosmosSelect('reports', 'SELECT DISTINCT c.reportId, c.reportTitle FROM c ORDER BY c.reportId')).map(report => {
+        map.set(report.reportId, report.reportTitle);
+    });
+    return map;
+}
+async function getAlertTitles() {
+    let map = new Map();
+    (await chatwmsCosmosSelect('alerts', 'SELECT DISTINCT c.alertId, c.alertTitle FROM c ORDER BY c.alertId')).map(alert => {
+        map.set(alert.alertId, alert.alertTitle);
+    });
+    return map;
+}
+export async function executeCosmosQuery(cosmosQuery, parameters, rowLimit) {
+    let queryMut = injectParameters(cosmosQuery.query, parameters);
+    if (!!rowLimit) {
+        // NOTE: we do not need to worry about semicolons or common table expressions -- these are not allowed in Cosmos.
+        queryMut = `SELECT TOP ${rowLimit} * FROM (${queryMut}) limit_sq`;
+    }
+    let res = await chatwmsCosmosSelect(cosmosQuery.table, queryMut);
+    if (res.length === 0) {
+        return [];
+    }
+    // Depending on the table/columns queried, we are going to inject a few things.
+    {
+        const firstRow = res[0];
+        let userDetails = undefined;
+        let clientDescriptions = undefined;
+        let dashboardTitles = undefined;
+        let reportTitles = undefined;
+        let alertTitles = undefined;
+        if ('userId' in firstRow && !('userDetails' in firstRow)) {
+            userDetails = await getUserDetails();
+        }
+        if ('clientId' in firstRow && !('description' in firstRow)) {
+            clientDescriptions = await getClientDescriptions();
+        }
+        if (cosmosQuery.table === 'dashboard_widgets' || cosmosQuery.table === 'dashboard_usage') {
+            if ('dashboardId' in firstRow && !('dashboardTitle' in firstRow)) {
+                dashboardTitles = await getDashboardTitles();
+            }
+        }
+        else if (cosmosQuery.table === 'report_lines' || cosmosQuery.table === 'report_usage') {
+            if ('reportId' in firstRow && !('reportTitle' in firstRow)) {
+                reportTitles = await getReportTitles();
+            }
+        }
+        else if (cosmosQuery.table === 'alert_subscriptions' || cosmosQuery.table === 'alert_executions') {
+            if ('alertId' in firstRow && !('alertTitle' in firstRow)) {
+                alertTitles = await getAlertTitles();
+            }
+        }
+        let rowIdx = 1;
+        res.forEach(row => {
+            // Include row number no matter what.
+            row['rowNumber'] = rowIdx++;
+            if (!!userDetails) {
+                row['userDetails'] = userDetails.get(row['userId']) ?? '';
+            }
+            if (!!clientDescriptions) {
+                row['description'] = clientDescriptions.get(row['clientId']) ?? '';
+            }
+            if (!!dashboardTitles) {
+                row['dashboardTitle'] = dashboardTitles.get(row['dashboardId']) ?? '';
+            }
+            else if (!!reportTitles) {
+                row['reportTitle'] = reportTitles.get(row['reportId']) ?? '';
+            }
+            else if (!!alertTitles) {
+                row['alertTitle'] = alertTitles.get(row['alertId']) ?? '';
+            }
+        });
+    }
+    return res;
+}

package/dist/chatwms/datagrid.d.ts

@@ -115,7 +115,7 @@ export interface DatagridCondition {
     value2?: string;
 }
 export declare function initDatagridCondition(): DatagridCondition;
-export declare function summarizeCondition(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>): Promise<string>;
+export declare function summarizeCondition(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>, markdown?: boolean): Promise<string>;
 export declare function codifyCondition(condition: DatagridCondition): string;
 /**
  * Equivalent of `parseNumeric` in front end

package/dist/chatwms/datagrid.js

@@ -265,26 +265,48 @@ export function initDatagridCondition() {
         value: ''
     };
 }
-export async function summarizeCondition(condition, localeMessageFn) {
+export async function summarizeCondition(condition, localeMessageFn, markdown) {
     let ruleStr = '';
-    switch (condition.rule) {
-        case ConditionalFormatRule.BETWEEN:
-            ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)} ${condition.value} ${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, 'conditional-format-rule-and')} ${condition.value2}`;
-            break;
-        case ConditionalFormatRule.BLANK:
-        case ConditionalFormatRule.NOT_BLANK:
-            ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}`;
-            break;
-        default:
-            if (condition.dataType === 'text') {
-                ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)} '${condition.value}'`;
-            }
-            else {
-                ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)} ${condition.value}`;
-            }
-            break;
+    if (!!markdown) {
+        switch (condition.rule) {
+            case ConditionalFormatRule.BETWEEN:
+                ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}** ${condition.value} **${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, 'conditional-format-rule-and')}** ${condition.value2}`;
+                break;
+            case ConditionalFormatRule.BLANK:
+            case ConditionalFormatRule.NOT_BLANK:
+                ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}**`;
+                break;
+            default:
+                if (condition.dataType === 'text') {
+                    ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}** '${condition.value}'`;
+                }
+                else {
+                    ruleStr = `**${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}** ${condition.value}`;
+                }
+                break;
+        }
+        return `\`${condition.columnName}\` ${ruleStr}`;
+    }
+    else {
+        switch (condition.rule) {
+            case ConditionalFormatRule.BETWEEN:
+                ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)} ${condition.value} ${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, 'conditional-format-rule-and')} ${condition.value2}`;
+                break;
+            case ConditionalFormatRule.BLANK:
+            case ConditionalFormatRule.NOT_BLANK:
+                ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)}`;
+                break;
+            default:
+                if (condition.dataType === 'text') {
+                    ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)} '${condition.value}'`;
+                }
+                else {
+                    ruleStr = `${await localeMessageFn(CHATWMS_DEFAULT_LANGUAGE, condition.rule)} ${condition.value}`;
+                }
+                break;
+        }
+        return `${condition.columnName} ${ruleStr}`;
     }
-    return `${condition.columnName} ${ruleStr}`;
 }
 export function codifyCondition(condition) {
     // NOTE: since we check for action/unsafe SQL with every query, we do not need to check for SQL injection here.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cellaware/utils",
-    "version": "8.2.2",
+    "version": "8.3.0",
     "description": "Cellaware Utilities for Node.js",
     "author": "Cellaware Technologies",
     "type": "module",