foxhound 2.0.22 → 2.0.23

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "foxhound",
-    "version": "2.0.22",
+    "version": "2.0.23",
     "description": "A Database Query generation library.",
     "main": "source/FoxHound.js",
     "scripts": {
@@ -11,7 +11,8 @@
         "build": "npx quack build",
         "docker-dev-build": "docker build ./ -f Dockerfile_LUXURYCode -t foxhound-image:local",
         "docker-dev-run": "docker run -it -d --name foxhound-dev -p 24238:8080 -p 42889:8086 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/foxhound\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" foxhound-image:local",
-        "docker-dev-shell": "docker exec -it foxhound-dev /bin/bash"
+        "docker-dev-shell": "docker exec -it foxhound-dev /bin/bash",
+        "check": "npx -p typescript tsc --noEmit"
     },
     "mocha": {
         "diff": true,
@@ -50,6 +51,7 @@
         "quackage": "^1.0.60"
     },
     "dependencies": {
-        "fable": "^3.1.63"
+        "fable": "^3.1.63",
+        "typescript": "^5.9.3"
     }
 }

package/source/FoxHound.js

@@ -25,6 +25,7 @@ var FoxHound = function()
 
 		// The parameters config object for the current query.  This is the only
 		// piece of internal state that is important to operation.
+		/** @type {Record<string, any>} */
 		var _Parameters = false;
 
 		var _Dialects = require('./Foxhound-Dialects.js');
@@ -36,6 +37,7 @@ var FoxHound = function()
 		var _LogLevel = 0;
 
 		// The dialect to use when generating queries
+		/** @type {Record<string, any>} */
 		var _Dialect = false;
 
 		/**
@@ -164,6 +166,7 @@ var FoxHound = function()
 		*/
 		var setScope = function(pScope)
 		{
+			/** @type {string} */
 			var tmpScope = false;
 
 			if (typeof(pScope) === 'string')
@@ -214,11 +217,12 @@ var FoxHound = function()
 		* The passed values can be either a string, or an array.
 		*
 		* @method setDataElements
-		* @param {String} pDataElements The Data Element(s) for the Query.
+		* @param {string | Array<string>} pDataElements The Data Element(s) for the Query.
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var setDataElements = function(pDataElements)
 		{
+			/** @type {Array<string>} */
 			var tmpDataElements = false;
 
 			if (Array.isArray(pDataElements))
@@ -251,11 +255,12 @@ var FoxHound = function()
 		* {Column:'Birthday', Direction:'Ascending'}
 		*
 		* @method setSort
-		* @param {String} pSort The sort criteria(s) for the Query.
+		* @param {string | Array<Record<string, any>>} pSort The sort criteria(s) for the Query.
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var setSort = function(pSort)
 		{
+			/** @type {Array<Record<string, any>>} */
 			var tmpSort = false;
 
 			if (Array.isArray(pSort))
@@ -325,11 +330,12 @@ var FoxHound = function()
 		* {Column:'Birthday', Direction:'Ascending'}
 		*
 		* @method setSort
-		* @param {String} pSort The sort criteria to add to the Query.
+		* @param {string | Record<string, any>} pSort The sort criteria to add to the Query.
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var addSort = function(pSort)
 		{
+			/** @type {Record<string, any>} */
 			var tmpSort = false;
 
 			if (typeof(pSort) === 'string')
@@ -368,11 +374,12 @@ var FoxHound = function()
 		* The passed value must be an Integer >= 0.
 		*
 		* @method setBegin
-		* @param {Number} pBeginAmount The index to begin returning Query data.
+		* @param {number | boolean} pBeginAmount The index to begin returning Query data.
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var setBegin = function(pBeginAmount)
 		{
+			/** @type {number} */
 			var tmpBegin = false;
 
 			// Test if it is an integer > -1
@@ -406,11 +413,12 @@ var FoxHound = function()
 		* The passed value must be an Integer >= 0.
 		*
 		* @method setCap
-		* @param {Number} pCapAmount The maximum records for the Query set.
+		* @param {number | boolean} pCapAmount The maximum records for the Query set.
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var setCap = function(pCapAmount)
 		{
+			/** @type {number} */
 			var tmpCapAmount = false;
 
 			if (typeof(pCapAmount) === 'number' && (pCapAmount % 1) === 0 && pCapAmount >= 0)
@@ -444,11 +452,12 @@ var FoxHound = function()
 		* {Column:'Name', Operator:'EQ', Value:'John', Connector:'And', Parameter:'Name'}
 		*
 		* @method setFilter
-		* @param {String} pFilter The filter(s) for the Query.
+		* @param {Array<Record<string, any>>} pFilter The filter(s) for the Query.
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var setFilter = function(pFilter)
 		{
+			/** @type {Record<string, any>} */
 			var tmpFilter = false;
 
 			if (Array.isArray(pFilter))
@@ -480,6 +489,11 @@ var FoxHound = function()
 		* {Column:'Name', Operator:'EQ', Value:'John', Connector:'And', Parameter:'Name'}
 		*
 		* @method addFilter
+		* @param {string} pColumn
+		* @param {any} pValue
+		* @param {string} [pOperator]
+		* @param {string} [pConnector]
+		* @param {string} [pParameter]
 		* @return {Object} Returns the current Query for chaining.
 		*/
 		var addFilter = function(pColumn, pValue, pOperator, pConnector, pParameter)
@@ -896,6 +910,7 @@ var FoxHound = function()
 		 *
 		 * @property dialect
 		 * @type Object
+		 * @return {Record<string, any>}
 		 */
 		Object.defineProperty(tmpNewFoxHoundObject, 'dialect',
 			{
@@ -919,7 +934,7 @@ var FoxHound = function()
 		 * Log Level
 		 *
 		 * @property logLevel
-		 * @type Integer
+		 * @type {number}
 		 */
 		Object.defineProperty(tmpNewFoxHoundObject, 'logLevel',
 			{

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

@@ -13,8 +13,8 @@ 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
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} Returns the table name clause
 	 */
 	var generateTableName = function(pParameters)
 	{
@@ -25,8 +25,8 @@ var FoxHoundDialectMeadowEndpoints = function()
 	 * Generate the Identity column from the schema or scope
 	 * 
 	 * @method: generateIdentityColumnName
-	 * @param: {Object} pParameters SQL Query Parameters
-	 * @return: {String} Returns the table name clause
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} Returns the table name clause
 	 */
 	var generateIdentityColumnName = function(pParameters)
 	{
@@ -40,8 +40,8 @@ var FoxHoundDialectMeadowEndpoints = function()
 	 * Each entry in the dataElements is a simple string
 	 *
 	 * @method: generateFieldList
-	 * @param: {Object} pParameters SQL Query Parameters
-	 * @return: {String} Returns the field list clause
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} Returns the field list clause
 	 */
 	var generateFieldList = function(pParameters)
 	{
@@ -77,8 +77,8 @@ var FoxHoundDialectMeadowEndpoints = function()
 		}
 	 *
 	 * @method: generateWhere
-	 * @param: {Object} pParameters SQL Query Parameters
-	 * @return: {String} Returns the WHERE clause prefixed with WHERE, or an empty string if unnecessary
+	 * @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)
 	{
@@ -99,7 +99,7 @@ var FoxHoundDialectMeadowEndpoints = function()
 
         let tmpfTranslateOperator = (pOperator) =>
         {
-            tmpNewOperator = 'EQ';
+            let tmpNewOperator = 'EQ';
             switch(pOperator.toUpperCase())
             {
                 case '!=':
@@ -199,8 +199,8 @@ var FoxHoundDialectMeadowEndpoints = function()
      * 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.
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} Flags to be sent, if any.
 	 */
     function generateFlags(pParameters)
     {
@@ -235,8 +235,8 @@ var FoxHoundDialectMeadowEndpoints = function()
 	 * 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
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} ID of the record in string form for the URI
 	 */
 	var getIDRecord = function(pParameters)
 	{
@@ -276,13 +276,14 @@ var FoxHoundDialectMeadowEndpoints = function()
 	 * {Column:'Color',Direction:'Descending'}
 	 *
 	 * @method: generateOrderBy
-	 * @param: {Object} pParameters SQL Query Parameters
-	 * @return: {String} Returns the field list clause
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} Returns the field list clause
 	 */
 	var generateOrderBy = function(pParameters)
 	{
 		var tmpOrderBy = pParameters.sort;
-		var tmpOrderClause = false;
+		/** @type {string} */
+		var tmpOrderClause = null;
 
         if (!Array.isArray(tmpOrderBy) || tmpOrderBy.length < 1)
 		{
@@ -315,8 +316,8 @@ var FoxHoundDialectMeadowEndpoints = function()
 	 * Generate the limit clause
 	 *
 	 * @method: generateLimit
-	 * @param: {Object} pParameters SQL Query Parameters
-	 * @return: {String} Returns the table name clause
+	 * @param {Object} pParameters SQL Query Parameters
+	 * @return {String} Returns the table name clause
 	 */
 	var generateLimit = function(pParameters)
 	{

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"include": ["source"],
+	"compilerOptions":
+	{
+		"allowJs": true,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"outDir": "dist",
+		"declarationMap": true,
+		"checkJs": true,
+		"lib": ["ES2020", "dom"]
+	}
+}