pict-section-form 1.0.127 → 1.0.128

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-section-form",
-    "version": "1.0.127",
+    "version": "1.0.128",
     "description": "Pict dynamic form sections",
     "main": "source/Pict-Section-Form.js",
     "directories": {

package/source/views/Pict-View-Form-Metacontroller.js

@@ -7,6 +7,10 @@ const libPictViewDynamicForm = require('./Pict-View-DynamicForm.js');
 // TODO: Manage view lifecycle internally, including destruction of views if they are flagged to not be needed.
 // Why?  This allows us to dynamically add and remove sections without having to reload the application.
 
+const PENDING_ASYNC_OPERATION_TYPE = 'PendingAsyncOperation';
+const TRANSACTION_COMPLETE_CALLBACK_TYPE = 'onTransactionComplete';
+const READY_TO_FINALIZE_TYPE = 'ReadyToFinalize';
+
 /**
  * @typedef {(a: any, b: any) => number} SortFunction
  */
@@ -940,6 +944,146 @@ class PictFormMetacontroller extends libPictViewClass
 		}
 	}
 
+	/**
+	 * @param {string} pTransactionGUID - The transaction GUID.
+	 * @param {string} pAsyncOperationHash - The hash of the async operation.
+	 */
+	registerEventTransactionAsyncOperation(pTransactionGUID, pAsyncOperationHash)
+	{
+		this.pict.TransactionTracking.pushToTransactionQueue(pTransactionGUID, pAsyncOperationHash, PENDING_ASYNC_OPERATION_TYPE);
+	}
+
+	/**
+	 * @param {string} pTransactionGUID - The transaction GUID.
+	 * @param {string} pAsyncOperationHash - The hash of the async operation.
+	 *
+	 * @return {boolean} - Returns true if the async operation was found and marked as complete, otherwise false.
+	 */
+	eventTransactionAsyncOperationComplete(pTransactionGUID, pAsyncOperationHash)
+	{
+		const tmpQueue = this.pict.TransactionTracking.checkTransactionQueue(pTransactionGUID);
+		let tmpPendingAsyncOperationCount = 0;
+		let tmpMarkedOperationCount = 0;
+		let tmpFinalized = false;
+		for (let i = 0; i < tmpQueue.length; i++)
+		{
+			const tmpQueueItem = tmpQueue[i];
+			if (tmpQueueItem.Type === PENDING_ASYNC_OPERATION_TYPE)
+			{
+				if (tmpQueueItem.Data === pAsyncOperationHash)
+				{
+					tmpQueue.splice(i, 1);
+					++tmpMarkedOperationCount;
+					--i;
+				}
+				else
+				{
+					++tmpPendingAsyncOperationCount;
+				}
+			}
+			if (tmpQueueItem.Type === READY_TO_FINALIZE_TYPE)
+			{
+				tmpFinalized = true;
+			}
+		}
+		if (tmpPendingAsyncOperationCount === 0)
+		{
+			for (const tmpQueueItem of tmpQueue)
+			{
+				if (tmpQueueItem.Type === TRANSACTION_COMPLETE_CALLBACK_TYPE)
+				{
+					if (typeof tmpQueueItem.Data !== 'function')
+					{
+						this.log.error(`PICT View Metatemplate Helper eventTransactionAsyncOperationComplete transaction callback was not a function.`);
+						continue;
+					}
+					try
+					{
+						tmpQueueItem.Data();
+					}
+					catch (pError)
+					{
+						this.log.error(`PICT View Metatemplate Helper eventTransactionAsyncOperationComplete transaction callback error: ${pError}`, { Stack: pError.stack });
+					}
+				}
+			}
+		}
+		return tmpMarkedOperationCount > 0;
+	}
+
+	/**
+	 * @param {string} pTransactionGUID - The transaction GUID.
+	 *
+	 * @return {boolean} - Returns true if the transaction was found and able to be finalized, otherwise false.
+	 */
+	finalizeTransaction(pTransactionGUID)
+	{
+		this.pict.TransactionTracking.pushToTransactionQueue(pTransactionGUID, null, READY_TO_FINALIZE_TYPE);
+
+		const tmpQueue = this.pict.TransactionTracking.checkTransactionQueue(pTransactionGUID);
+		let tmpPendingAsyncOperationCount = 0;
+		for (const tmpQueueItem of tmpQueue)
+		{
+			if (tmpQueueItem.Type === PENDING_ASYNC_OPERATION_TYPE)
+			{
+				++tmpPendingAsyncOperationCount;
+			}
+		}
+		if (tmpPendingAsyncOperationCount > 0)
+		{
+			this.pict.log.info(`PICT View Metatemplate Helper finalizeTransaction ${pTransactionGUID} is waiting on ${tmpPendingAsyncOperationCount} pending async operations.`);
+			return false;
+		}
+		for (const tmpQueueItem of tmpQueue)
+		{
+			if (tmpQueueItem.Type === TRANSACTION_COMPLETE_CALLBACK_TYPE)
+			{
+				if (typeof tmpQueueItem.Data !== 'function')
+				{
+					this.log.error(`PICT View Metatemplate Helper eventTransactionAsyncOperationComplete transaction callback was not a function.`);
+					continue;
+				}
+				try
+				{
+					tmpQueueItem.Data();
+				}
+				catch (pError)
+				{
+					this.log.error(`PICT View Metatemplate Helper eventTransactionAsyncOperationComplete transaction callback error: ${pError}`, { Stack: pError.stack });
+				}
+			}
+		}
+		//TODO: figure out how to safely clean up old transactions
+		//delete this.pict.TransactionTracking.transactions[pTransactionGUID];
+		return true;
+	}
+
+	/**
+	 * @param {string} pTransactionGUID - The transaction GUID.
+	 * @param {Function} fCallback - The callback to call when the transaction is complete.
+	 */
+	registerOnTransactionCompleteCallback(pTransactionGUID, fCallback)
+	{
+		const tmpQueue = this.pict.TransactionTracking.checkTransactionQueue(pTransactionGUID);
+		let tmpFinalized = false;
+		for (const tmpQueueItem of tmpQueue)
+		{
+			if (tmpQueueItem.Type === READY_TO_FINALIZE_TYPE)
+			{
+				tmpFinalized = true;
+				break;
+			}
+		}
+		if (tmpFinalized)
+		{
+			fCallback();
+		}
+		else
+		{
+			this.pict.TransactionTracking.pushToTransactionQueue(pTransactionGUID, fCallback, TRANSACTION_COMPLETE_CALLBACK_TYPE);
+		}
+	}
+
 	/**
 	 * Returns whether the object is a Pict Metacontroller.
 	 *

package/types/source/providers/Pict-Provider-DynamicFormSolverBehaviors.d.ts

@@ -44,10 +44,10 @@ declare class PictDynamicFormsSolverBehaviors extends libPictProvider {
      * @param {string} pInputHash - The hash of the input to color.
      * @param {string} pColor - The HTML hex color to apply (e.g. #FF0000 for red).
      * @param {string} pApplyChange - If "0", the change will not be applied.
-     * @param {string} [pClassTarget] - Optional. If provided, the color will be applied to the closest element with this class instead of the input itself.
+     * @param {string} [pCSSSelector] - Optional. If provided, the color will be applied to the closest element matching this selector instead of the input itself.
      * @returns {boolean} - Returns true if the color was applied successfully or if the change was skipped for pApplyChange equal to "0", false otherwise.
      */
-    colorInputBackground(pSectionHash: string, pInputHash: string, pColor: string, pApplyChange: string, pClassTarget?: string): boolean;
+    colorInputBackground(pSectionHash: string, pInputHash: string, pColor: string, pApplyChange: string, pCSSSelector?: string): boolean;
     logValues(...args: any[]): any;
 }
 declare namespace PictDynamicFormsSolverBehaviors {

package/types/source/views/Pict-View-Form-Metacontroller.d.ts

@@ -160,6 +160,29 @@ declare class PictFormMetacontroller extends libPictViewClass {
      * @param {string} [pTransactionGUID] - (optional) The transaction GUID to use for the event.
      */
     triggerGlobalInputEvent(pEvent: string, pTransactionGUID?: string): void;
+    /**
+     * @param {string} pTransactionGUID - The transaction GUID.
+     * @param {string} pAsyncOperationHash - The hash of the async operation.
+     */
+    registerEventTransactionAsyncOperation(pTransactionGUID: string, pAsyncOperationHash: string): void;
+    /**
+     * @param {string} pTransactionGUID - The transaction GUID.
+     * @param {string} pAsyncOperationHash - The hash of the async operation.
+     *
+     * @return {boolean} - Returns true if the async operation was found and marked as complete, otherwise false.
+     */
+    eventTransactionAsyncOperationComplete(pTransactionGUID: string, pAsyncOperationHash: string): boolean;
+    /**
+     * @param {string} pTransactionGUID - The transaction GUID.
+     *
+     * @return {boolean} - Returns true if the transaction was found and able to be finalized, otherwise false.
+     */
+    finalizeTransaction(pTransactionGUID: string): boolean;
+    /**
+     * @param {string} pTransactionGUID - The transaction GUID.
+     * @param {Function} fCallback - The callback to call when the transaction is complete.
+     */
+    registerOnTransactionCompleteCallback(pTransactionGUID: string, fCallback: Function): void;
     /**
      * Returns whether the object is a Pict Metacontroller.
      *

package/types/source/views/Pict-View-Form-Metacontroller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Pict-View-Form-Metacontroller.d.ts","sourceRoot":"","sources":["../../../source/views/Pict-View-Form-Metacontroller.js"],"names":[],"mappings":";AASA;;GAEG;AAEH;;;;;;GAMG;AACH;IAEC,2DAaC;IALA,yBAA2B;IAE3B,wBAAsF;IAEtF,cAAkC;IAQnC,wCAGC;IARD,kCAGC;IAOD;;;;OAIG;IACH,qBAFa,GAAG,CAaf;IAED;;;;OAIG;IACH,mBAFa,GAAG,CAaf;IAED,yCAYC;IAED;;;;;OAKG;IACH,kCAHW,aAAa,GACX,IAAI,CAsBhB;IAwBD;;;;OAIG;IACH,WAFa,GAAG,CAMf;IAED,gDAGC;IAED,+CAGC;IAED;;;;OAIG;IACH,2DAJW,MAAM,GAEL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAW9B;IAED;;;OAGG;IACH,0BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,sBACnB,MAAM,QAiChB;IAED;;;;;;;;;OASG;IACH,kCALW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UACnB,MAAM,GAEL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAsC9B;IAED;;;;OAIG;IACH,uCAJW,KAAK,CAAC,MAAM,CAAC,sBACb,MAAM,UACN,MAAM,QAahB;IAED;;;OAGG;IACH,6CAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,sBACnB,MAAM,SAehB;IAED;;;;;;;;OAQG;IACH,wDAHW,YAAY,SAoHtB;IAED;;;;;;;OAOG;IACH,4CAHW,MAAM,GACJ,IAAI,CAShB;IAED;;;;OAIG;IACH,6BAFa,IAAI,CAQhB;IAED;;;;;;;OAOG;IACH,+DAFW,YAAY,QAatB;IAED;;;;;OAKG;IACH,8EAFW,YAAY,QAmBtB;IAED;;;;;;OAMG;IACH,oEAHW,YAAY,GACV,IAAI,CAkDhB;IAED;;;;;;;OAOG;IACH,uEAJW,YAAY,GAEX,IAAI,CAsFf;IAED;;;;;OAKG;IACH,qCAHW,MAAM,GACJ,MAAM,GAAC,OAAO,CA2C1B;IAED,+CAeC;IAED;;;;;;;OAOG;IACH,kFAJW,MAAM,GAEJ,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAoLtC;IA5JC,gCAA0D;IAC1D,yBAAiD;IA6JnD;;;;OAIG;IACH,gCAHW,MAAM,qBACN,MAAM,QA0BhB;IAED;;;;OAIG;IACH,4BAFa,OAAO,CAKnB;CACD;;;;;qCAGU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAh7BjB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM"}
+{"version":3,"file":"Pict-View-Form-Metacontroller.d.ts","sourceRoot":"","sources":["../../../source/views/Pict-View-Form-Metacontroller.js"],"names":[],"mappings":";AAaA;;GAEG;AAEH;;;;;;GAMG;AACH;IAEC,2DAaC;IALA,yBAA2B;IAE3B,wBAAsF;IAEtF,cAAkC;IAQnC,wCAGC;IARD,kCAGC;IAOD;;;;OAIG;IACH,qBAFa,GAAG,CAaf;IAED;;;;OAIG;IACH,mBAFa,GAAG,CAaf;IAED,yCAYC;IAED;;;;;OAKG;IACH,kCAHW,aAAa,GACX,IAAI,CAsBhB;IAwBD;;;;OAIG;IACH,WAFa,GAAG,CAMf;IAED,gDAGC;IAED,+CAGC;IAED;;;;OAIG;IACH,2DAJW,MAAM,GAEL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAW9B;IAED;;;OAGG;IACH,0BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,sBACnB,MAAM,QAiChB;IAED;;;;;;;;;OASG;IACH,kCALW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UACnB,MAAM,GAEL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAsC9B;IAED;;;;OAIG;IACH,uCAJW,KAAK,CAAC,MAAM,CAAC,sBACb,MAAM,UACN,MAAM,QAahB;IAED;;;OAGG;IACH,6CAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,sBACnB,MAAM,SAehB;IAED;;;;;;;;OAQG;IACH,wDAHW,YAAY,SAoHtB;IAED;;;;;;;OAOG;IACH,4CAHW,MAAM,GACJ,IAAI,CAShB;IAED;;;;OAIG;IACH,6BAFa,IAAI,CAQhB;IAED;;;;;;;OAOG;IACH,+DAFW,YAAY,QAatB;IAED;;;;;OAKG;IACH,8EAFW,YAAY,QAmBtB;IAED;;;;;;OAMG;IACH,oEAHW,YAAY,GACV,IAAI,CAkDhB;IAED;;;;;;;OAOG;IACH,uEAJW,YAAY,GAEX,IAAI,CAsFf;IAED;;;;;OAKG;IACH,qCAHW,MAAM,GACJ,MAAM,GAAC,OAAO,CA2C1B;IAED,+CAeC;IAED;;;;;;;OAOG;IACH,kFAJW,MAAM,GAEJ,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAoLtC;IA5JC,gCAA0D;IAC1D,yBAAiD;IA6JnD;;;;OAIG;IACH,gCAHW,MAAM,qBACN,MAAM,QA0BhB;IAED;;;OAGG;IACH,yDAHW,MAAM,uBACN,MAAM,QAKhB;IAED;;;;;OAKG;IACH,yDALW,MAAM,uBACN,MAAM,GAEL,OAAO,CAoDlB;IAED;;;;OAIG;IACH,sCAJW,MAAM,GAEL,OAAO,CA0ClB;IAED;;;OAGG;IACH,wDAHW,MAAM,6BAuBhB;IAED;;;;OAIG;IACH,4BAFa,OAAO,CAKnB;CACD;;;;;qCAGU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBA5jCjB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM"}