foxhound 1.0.31 → 1.0.34

package/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Launch Program",
+            "outputCapture": "std",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/debug/Harness.js"
+        }
+    ]
+}

package/debug/Harness.js

@@ -0,0 +1,46 @@
+var libFable = require('fable').new({});
+var libFoxHound = require('../source/FoxHound.js');
+
+var _AnimalSchema = (
+[
+	{ Column: "IDAnimal",        Type:"AutoIdentity" },
+	{ Column: "GUIDAnimal",      Type:"AutoGUID" },
+	{ Column: "CreateDate",      Type:"CreateDate" },
+	{ Column: "CreatingIDUser",  Type:"CreateIDUser" },
+	{ Column: "UpdateDate",        Type:"UpdateDate" },
+	{ Column: "UpdatingIDUser", Type:"UpdateIDUser" },
+	{ Column: "Deleted",         Type:"Deleted" },
+	{ Column: "DeletingIDUser",  Type:"DeleteIDUser" },
+	{ Column: "DeleteDate",      Type:"DeleteDate" }
+]);
+
+var _AnimalSchemaWithoutDeleted = (
+[
+	{ Column: "IDAnimal",        Type:"AutoIdentity" },
+	{ Column: "GUIDAnimal",      Type:"AutoGUID" },
+	{ Column: "CreateDate",      Type:"CreateDate" },
+	{ Column: "CreatingIDUser",  Type:"CreateIDUser" },
+	{ Column: "UpdateDate",        Type:"UpdateDate" },
+	{ Column: "UpdatingIDUser", Type:"UpdateIDUser" }
+]);
+
+var tmpQuery = libFoxHound.new(libFable)
+.setDialect('MeadowEndpoints')
+.setScope('Animal')
+.setDataElements(['Name', 'Age', 'Cost'])
+.setCap(100)
+.addFilter('Age', '25')
+.addFilter('', '', '(')
+.addFilter('Color', 'Red')
+.addFilter('Color', 'Green', '=', 'OR')
+.addFilter('', '', ')')
+.addFilter('Description', '', 'IS NOT NULL')
+.addFilter('IDOffice', [10, 11, 15, 18, 22], 'IN');
+tmpQuery.setLogLevel(3).addSort('Age');
+// Build the query
+tmpQuery.buildReadQuery();
+// This is the query generated by the MeadowEndpoints dialect
+libFable.log.trace('Select Query', tmpQuery.query);
+
+
+console.log(tmpQuery.query.body);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foxhound",
-  "version": "1.0.31",
+  "version": "1.0.34",
   "description": "A Database Query generation library.",
   "main": "source/FoxHound.js",
   "scripts": {

package/source/FoxHound.js

@@ -194,6 +194,26 @@ var FoxHound = function()
 			return this;
 		};
 
+		/**
+		* Set whether the query returns DISTINCT results.
+		* For count queries, returns the distinct for the selected fields, or all fields in the base table by default.
+		*
+		* @method setDistinct
+		* @param {Boolean} pDistinct True if the query should be distinct.
+		* @return {Object} Returns the current Query for chaining.
+		*/
+		var setDistinct = function(pDistinct)
+		{
+			_Parameters.distinct = !!pDistinct;
+
+			if (_LogLevel > 2)
+			{
+				_Fable.log.info('Distinct set: '+_Parameters.distinct, {queryUUID:_UUID, parameters:_Parameters});
+			}
+
+			return this;
+		};
+
 
 		/**
 		* Set the Data Elements for the Query.  *Data Elements* are the fields
@@ -792,6 +812,7 @@ var FoxHound = function()
 			setLogLevel: setLogLevel,
 
 			setScope: setScope,
+			setDistinct: setDistinct,
 			setIDUser: setIDUser,
 			setDataElements: setDataElements,
 			setBegin: setBegin,

package/source/dialects/ALASQL/FoxHound-Dialect-ALASQL.js

@@ -21,7 +21,7 @@ var FoxHoundDialectALASQL = function()
 {
 	/**
 	 * Generate a table name from the scope.
-	 * 
+	 *
 	 * Because ALASQL is all in-memory, and can be run in two modes (anonymous
 	 * working on arrays or table-based) we are going to make this a programmable
 	 * value.  Then we can share the code across both providers.
@@ -34,7 +34,7 @@ var FoxHoundDialectALASQL = function()
 	{
 		return ' '+pParameters.scope;
 	};
-	
+
 	/**
 	 * Escape columns, because ALASQL has more reserved KWs than most SQL dialects
 	 */
@@ -67,14 +67,33 @@ var FoxHoundDialectALASQL = function()
 	 *
 	 * @method: generateFieldList
 	 * @param: {Object} pParameters SQL Query Parameters
-	 * @return: {String} Returns the field list clause
+	 * @param {Boolean} pIsForCountClause (optional) If true, generate fields for use within a count clause.
+	 * @return: {String} Returns the field list clause, or empty string if explicit fields are requested but cannot be fulfilled
+	 *          due to missing schema.
 	 */
-	var generateFieldList = function(pParameters)
+	var generateFieldList = function(pParameters, pIsForCountClause)
 	{
 		var tmpDataElements = pParameters.dataElements;
 		if (!Array.isArray(tmpDataElements) || tmpDataElements.length < 1)
 		{
-			return ' *';
+			if (!pIsForCountClause)
+			{
+				return ' *';
+			}
+			// we need to list all of the table fields explicitly; get them from the schema
+			const tmpSchema = Array.isArray(pParameters.query.schema) ? pParameters.query.schema : [];
+			if (tmpSchema.length < 1)
+			{
+				// this means we have no schema; returning an empty string here signals the calling code to handle this case
+				return '';
+			}
+			const idColumn = tmpSchema.find((entry) => entry.Type === 'AutoIdentity');
+			if (!idColumn)
+			{
+				// this means there is no autoincrementing unique ID column; treat as above
+				return '';
+			}
+			return ` ${idColumn.Column}`;
 		}
 
 		var tmpFieldList = ' ';
@@ -94,10 +113,10 @@ var FoxHoundDialectALASQL = function()
 	 *
 	 * Each clause is an object like:
 		{
-			Column:'Name', 
-			Operator:'EQ', 
-			Value:'John', 
-			Connector:'And', 
+			Column:'Name',
+			Operator:'EQ',
+			Value:'John',
+			Connector:'And',
 			Parameter:'Name'
 		}
 	 *
@@ -685,13 +704,14 @@ var FoxHoundDialectALASQL = function()
 		var tmpWhere = generateWhere(pParameters);
 		var tmpOrderBy = generateOrderBy(pParameters);
 		var tmpLimit = generateLimit(pParameters);
+		const tmpOptDistinct = pParameters.distinct ? ' DISTINCT' : '';
 
 		if (pParameters.queryOverride)
 		{
 			try
 			{
 				var tmpQueryTemplate = libUnderscore.template(pParameters.queryOverride);
-				return tmpQueryTemplate({FieldList:tmpFieldList, TableName:tmpTableName, Where:tmpWhere, OrderBy:tmpOrderBy, Limit:tmpLimit});
+				return tmpQueryTemplate({FieldList:tmpFieldList, TableName:tmpTableName, Where:tmpWhere, OrderBy:tmpOrderBy, Limit:tmpLimit, Distinct: tmpOptDistinct});
 			}
 			catch (pError)
 			{
@@ -701,7 +721,7 @@ var FoxHoundDialectALASQL = function()
 			}
 		}
 
-		return 'SELECT'+tmpFieldList+' FROM'+tmpTableName+tmpWhere+tmpOrderBy+tmpLimit+';';
+		return `SELECT${tmpOptDistinct}${tmpFieldList} FROM${tmpTableName}${tmpWhere}${tmpOrderBy}${tmpLimit};`;
 	};
 
 	var Update = function(pParameters)
@@ -739,13 +759,20 @@ var FoxHoundDialectALASQL = function()
 	{
 		var tmpTableName = generateTableName(pParameters);
 		var tmpWhere = generateWhere(pParameters);
+		const tmpFieldList = pParameters.distinct ? generateFieldList(pParameters, true) : '*';
 
+		// here, we ignore the distinct keyword if no fields have been specified and
+		if (pParameters.distinct && tmpFieldList.length < 1)
+		{
+			console.warn('Distinct requested but no field list or schema are available, so not honoring distinct for count query.');
+		}
+		const tmpOptDistinct = pParameters.distinct && tmpFieldList.length > 0 ? 'DISTINCT' : '';
 		if (pParameters.queryOverride)
 		{
 			try
 			{
 				var tmpQueryTemplate = libUnderscore.template(pParameters.queryOverride);
-				return tmpQueryTemplate({FieldList:[], TableName:tmpTableName, Where:tmpWhere, OrderBy:'', Limit:''});
+				return tmpQueryTemplate({FieldList:[], TableName:tmpTableName, Where:tmpWhere, OrderBy:'', Limit:'', Distinct: tmpOptDistinct});
 			}
 			catch (pError)
 			{
@@ -755,7 +782,7 @@ var FoxHoundDialectALASQL = function()
 			}
 		}
 
-		return 'SELECT COUNT(*) AS RowCount FROM'+tmpTableName+tmpWhere+';';
+		return `SELECT COUNT(${tmpOptDistinct}${tmpFieldList || '*'}) AS RowCount FROM${tmpTableName}${tmpWhere};`;
 	};
 
 	var tmpDialect = ({

package/source/dialects/English/FoxHound-Dialect-English.js

@@ -35,8 +35,9 @@ var FoxHoundDialectEnglish = function()
 	var Read = function(pParameters)
 	{
 		var tmpScope = pParameters.scope;
+		const tmpDistinct = pParameters.distinct ? 'unique ' : '';
 
-		return 'Please give me all your '+tmpScope+' records.  Thanks.';
+		return `Please give me all your ${tmpDistinct}${tmpScope} records.  Thanks.`;
 	};
 
 	var Update = function(pParameters)
@@ -56,8 +57,9 @@ var FoxHoundDialectEnglish = function()
 	var Count = function(pParameters)
 	{
 		var tmpScope = pParameters.scope;
+		const tmpDistinct = pParameters.distinct ? 'unique ' : '';
 
-		return 'Count your '+tmpScope+'.';
+		return `Count your ${tmpDistinct}${tmpScope}.`;
 	};
 
 	var tmpDialect = ({

package/source/dialects/MeadowEndpoints/FoxHound-Dialect-MeadowEndpoints.js

@@ -0,0 +1,445 @@
+/**
+* FoxHound Meadow Endpoints Dialect
+*
+* @license MIT
+*
+* @author Steven Velozo <steven@velozo.com>
+* @class FoxHoundDialectMeadowEndpoints
+*/
+var libUnderscore = require('underscore');
+
+var FoxHoundDialectMeadowEndpoints = function()
+{
+	/**
+	 * Generate a table name from the scope
+	 *
+	 * @method: generateTableName
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} Returns the table name clause
+	 */
+	var generateTableName = function(pParameters)
+	{
+		return pParameters.scope;
+	};
+
+	/**
+	 * Generate a field list from the array of dataElements
+	 *
+	 * Each entry in the dataElements is a simple string
+	 *
+	 * @method: generateFieldList
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} Returns the field list clause
+	 */
+	var generateFieldList = function(pParameters)
+	{
+		var tmpDataElements = pParameters.dataElements;
+		if (!Array.isArray(tmpDataElements) || tmpDataElements.length < 1)
+		{
+			return '';
+		}
+
+		var tmpFieldList = '';
+		for (var i = 0; i < tmpDataElements.length; i++)
+		{
+			if (i > 0)
+			{
+				tmpFieldList += ',';
+			}
+
+            tmpFieldList += tmpDataElements[i];
+		}
+		return tmpFieldList;
+	};
+
+	/**
+	 * Generate a query from the array of where clauses
+	 *
+	 * Each clause is an object like:
+		{
+			Column:'Name', 
+			Operator:'EQ', 
+			Value:'John', 
+			Connector:'And', 
+			Parameter:'Name'
+		}
+	 *
+	 * @method: generateWhere
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} Returns the WHERE clause prefixed with WHERE, or an empty string if unnecessary
+	 */
+	var generateWhere = function(pParameters)
+	{
+		var tmpFilter = Array.isArray(pParameters.filter) ? pParameters.filter : [];
+		var tmpTableName = generateTableName(pParameters);
+        
+        var tmpURL = '';
+
+        let tmpfAddFilter = (pFilterCommand, pFilterParameters) =>
+        {
+            if (tmpURL.length > 0)
+            {
+                tmpURL += '~';
+            }
+            
+            tmpURL += `${pFilterCommand}~${pFilterParameters[0]}~${pFilterParameters[1]}~${pFilterParameters[2]}`;
+        };
+
+        let tmpfTranslateOperator = (pOperator) =>
+        {
+            tmpNewOperator = 'EQ';
+            switch(pOperator.toUpperCase())
+            {
+                case '!=':
+                    tmpNewOperator = 'NE';
+                    break;
+                case '>':
+                    tmpNewOperator = 'GT';
+                    break;
+                case '>=':
+                    tmpNewOperator = 'GE';
+                    break;
+                case '<=':
+                    tmpNewOperator = 'LE';
+                    break;
+                case '<':
+                    tmpNewOperator = 'LT';
+                    break;
+                case 'LIKE':
+                    tmpNewOperator = 'LK';
+                    break;
+                case 'IN':
+                    tmpNewOperator = 'INN';
+                    break;
+                case 'NOT IN':
+                    tmpNewOperator = 'NI';
+                    break;
+            }
+            return tmpNewOperator;
+        }
+
+        // Translating Delete Tracking bit on query to a query with automagic
+        // This will eventually deprecate this as part of the necessary query
+        if (pParameters.query.disableDeleteTracking)
+        {
+            tmpfAddFilter('FBV',['Deleted','GE','0'])
+        }
+
+		for (var i = 0; i < tmpFilter.length; i++)
+		{
+			if (tmpFilter[i].Operator === '(')
+			{
+                tmpfAddFilter('FOP',['0','(','0']);
+			}
+			else if (tmpFilter[i].Operator === ')')
+			{
+				// Close a logical grouping
+                tmpfAddFilter('FCP',['0',')','0']);
+			}
+			else if (tmpFilter[i].Operator === 'IN' || tmpFilter[i].Operator === "NOT IN")
+			{
+                let tmpFilterCommand = 'FBV';
+                if (tmpFilter[i].Connector == 'OR')
+                {
+                    tmpFilterCommand = 'FBVOR';
+                }
+				// Add the column name, operator and parameter name to the list of where value parenthetical
+                tmpfAddFilter(tmpFilterCommand, [tmpFilter[i].Column, tmpfTranslateOperator(tmpFilter[i].Operator), tmpFilter[i].Value.map(encodeURIComponent).join(',')])
+			}
+			else if (tmpFilter[i].Operator === 'IS NULL')
+			{
+				// IS NULL is a special operator which doesn't require a value, or parameter
+                tmpfAddFilter('FBV', [tmpFilter[i].Column, 'IN', '0']);
+			}
+			else if (tmpFilter[i].Operator === 'IS NOT NULL')
+			{
+				// IS NOT NULL is a special operator which doesn't require a value, or parameter
+                tmpfAddFilter('FBV', [tmpFilter[i].Column, 'NN', '0']);
+			}
+			else
+			{
+                let tmpFilterCommand = 'FBV';
+                if (tmpFilter[i].Connector == 'OR')
+                {
+                    tmpFilterCommand = 'FBVOR';
+                }
+				// Add the column name, operator and parameter name to the list of where value parenthetical
+                tmpfAddFilter(tmpFilterCommand, [tmpFilter[i].Column, tmpfTranslateOperator(tmpFilter[i].Operator), encodeURIComponent(tmpFilter[i].Value)]);
+			}
+		}
+
+        let tmpOrderBy = generateOrderBy(pParameters);
+        if (tmpOrderBy)
+        {
+            if (tmpURL)
+            {
+                tmpURL += '~';
+            }
+            tmpURL += tmpOrderBy;
+        }
+
+		return tmpURL;
+	};
+
+    /**
+	 * Get the flags for the request
+     * 
+     * These are usually passed in for Update and Create when extra tracking is disabled.
+	 *
+	 * @method: generateFlags
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} Flags to be sent, if any.
+	 */
+    function generateFlags(pParameters)
+    {
+        let tmpDisableAutoDateStamp = pParameters.query.disableAutoDateStamp;
+        let tmpDisableDeleteTracking = pParameters.query.disableDeleteTracking;
+        let tmpDisableAutoIdentity = pParameters.query.disableAutoIdentity;
+        let tmpDisableAutoUserStamp = pParameters.query.disableAutoUserStamp;
+
+        let tmpFlags = '';
+
+        let fAddFlag = (pFlagSet, pFlag) =>
+            {
+                if (pFlagSet)
+                {
+                    if (tmpFlags.length > 0)
+                    {
+                        tmpFlags += ',';
+                    }
+                    tmpFlags += pFlag;
+                }
+            };
+
+        fAddFlag(tmpDisableAutoDateStamp, 'DisableAutoDateStamp');
+        fAddFlag(tmpDisableDeleteTracking, 'DisableDeleteTracking');
+        fAddFlag(tmpDisableAutoIdentity, 'DisableAutoIdentity');
+        fAddFlag(tmpDisableAutoUserStamp, 'DisableAutoUserStamp');
+
+        return tmpFlags;
+    };
+
+    /**
+	 * Get the ID for the record, to be used in URIs
+	 *
+	 * @method: getIDRecord
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} ID of the record in string form for the URI
+	 */
+	var getIDRecord = function(pParameters)
+	{
+        var tmpFilter = Array.isArray(pParameters.filter) ? pParameters.filter : [];
+
+		var tmpIDRecord = false;
+
+        if (tmpFilter.length < 1)
+		{
+			return tmpIDRecord;
+		}
+
+		for (var i = 0; i < tmpFilter.length; i++)
+		{
+            // Check Schema Entry Type
+            var tmpSchema = Array.isArray(pParameters.query.schema) ? pParameters.query.schema : [];
+			var tmpSchemaEntry = {Column:tmpFilter[i].Column, Type:'Default'};
+			for (var j = 0; j < tmpSchema.length; j++)
+			{
+                // If this column is the AutoIdentity, set it.
+				if ((tmpFilter[i].Column == tmpSchema[j].Column) &&
+                    (tmpSchema[j].Type == 'AutoIdentity'))
+				{
+                    tmpIDRecord = tmpFilter[i].Value;
+					break;
+				}
+			}
+		}
+
+		return tmpIDRecord;
+    }
+	
+    /**
+	 * Generate an ORDER BY clause from the sort array
+	 *
+	 * Each entry in the sort is an object like:
+	 * {Column:'Color',Direction:'Descending'}
+	 *
+	 * @method: generateOrderBy
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} Returns the field list clause
+	 */
+	var generateOrderBy = function(pParameters)
+	{
+		var tmpOrderBy = pParameters.sort;
+		var tmpOrderClause = false;
+
+        if (!Array.isArray(tmpOrderBy) || tmpOrderBy.length < 1)
+		{
+			return tmpOrderClause;
+		}
+
+        tmpOrderClause = '';
+
+        for (var i = 0; i < tmpOrderBy.length; i++)
+		{
+			if (i > 0)
+			{
+				tmpOrderClause += '~';
+			}
+			tmpOrderClause += `FSF~${tmpOrderBy[i].Column}~`;
+
+			if (tmpOrderBy[i].Direction == 'Descending')
+			{
+				tmpOrderClause += 'DESC~0';
+			}
+            else
+            {
+                tmpOrderClause += 'ASC~0'
+            }
+		}
+		return tmpOrderClause;
+	};
+
+	/**
+	 * Generate the limit clause
+	 *
+	 * @method: generateLimit
+	 * @param: {Object} pParameters SQL Query Parameters
+	 * @return: {String} Returns the table name clause
+	 */
+	var generateLimit = function(pParameters)
+	{
+		if (!pParameters.cap)
+		{
+			return '';
+		}
+
+        let tmpBegin = (pParameters.begin !== false) ? pParameters.begin : 0;
+
+        return `${tmpBegin}/${pParameters.cap}`;
+	};
+
+	var Create = function(pParameters)
+	{
+		var tmpTableName = generateTableName(pParameters);
+        var tmpFlags = generateFlags(pParameters);
+
+        if (tmpTableName)
+        {
+            let tmpURL = tmpTableName;
+            if (tmpFlags)
+            {
+                tmpURL = `${tmpURL}/WithFlags/${tmpFlags}`
+            }
+            return tmpURL;
+        }
+        else
+        {
+            return false;
+        }
+	};
+
+
+	/**
+	* Read one or many records
+	*
+	* @method Read
+	* @param {Object} pParameters SQL Query parameters
+	* @return {String} Returns the current Query for chaining.
+	*/
+	var Read = function(pParameters)
+	{
+		var tmpTableName = generateTableName(pParameters);
+		var tmpFieldList = generateFieldList(pParameters);
+		var tmpWhere = generateWhere(pParameters);
+		var tmpLimit = generateLimit(pParameters);
+
+        var tmpURL = `${tmpTableName}s`;
+        if (tmpFieldList)
+        {
+            tmpURL = `${tmpURL}/LiteExtended/${tmpFieldList}`
+        }
+        if (tmpWhere)
+        {
+            tmpURL = `${tmpURL}/FilteredTo/${tmpWhere}`;
+        }
+        if (tmpLimit)
+        {
+            tmpURL = `${tmpURL}/${tmpLimit}`;
+        }
+
+		return tmpURL;
+        ///'SELECT'+tmpFieldList+' FROM'+tmpTableName+tmpJoin+tmpWhere+tmpOrderBy+tmpLimit+';';
+	};
+
+	var Update = function(pParameters)
+	{
+		var tmpTableName = generateTableName(pParameters);
+        var tmpFlags = generateFlags(pParameters);
+
+        if (tmpTableName)
+        {
+            let tmpURL = tmpTableName;
+            if (tmpFlags)
+            {
+                tmpURL = `${tmpURL}/WithFlags/${tmpFlags}`
+            }
+            return tmpURL;
+        }
+        else
+        {
+            return false;
+        }
+	};
+
+	var Delete = function(pParameters)
+	{
+		var tmpTableName = generateTableName(pParameters);
+		var tmpIDRecord = getIDRecord(pParameters);
+
+        if (!tmpIDRecord)
+        {
+            return false;
+        }
+
+		return `${tmpTableName}/${tmpIDRecord}`;
+	};
+
+	var Count = function(pParameters)
+	{
+		var tmpTableName = generateTableName(pParameters);
+		var tmpWhere = generateWhere(pParameters);
+
+        let tmpCountQuery = `${tmpTableName}s/Count`;
+
+        if (tmpWhere)
+        {
+            return `${tmpCountQuery}s/Count/FilteredTo/${tmpWhere}`;
+        }
+
+        return tmpCountQuery;
+	};
+
+	var tmpDialect = ({
+		Create: Create,
+		Read: Read,
+		Update: Update,
+		Delete: Delete,
+		Count: Count
+	});
+
+	/**
+	 * Dialect Name
+	 *
+	 * @property name
+	 * @type string
+	 */
+	Object.defineProperty(tmpDialect, 'name',
+		{
+			get: function() { return 'MeadowEndpoints'; },
+			enumerable: true
+		});
+
+	return tmpDialect;
+};
+
+module.exports = new FoxHoundDialectMeadowEndpoints();