pict-section-form 1.0.165 → 1.0.166

package/example_applications/complex_table/Complex-Tabular-Application.js

@@ -2,6 +2,62 @@ const libPictSectionForm = require('../../source/Pict-Section-Form.js');
 
 const libCustomDataProvider = require('./Complex-Tabular-CustomDataProvider.js');
 
+const SelectInputProvider = require('../../source/providers/inputs/Pict-Provider-Input-Select.js');
+
+class CustomSelectInputProvider extends SelectInputProvider
+{
+	/**
+	 * Handles events for the Pict-Provider-InputExtension.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {Object} pInput - The input object.
+	 * @param {any} pValue - The value from AppData.
+	 * @param {string} pHTMLSelector - The HTML selector.
+	 * @param {string} pEvent - The event hash that is expected to be triggered.
+	 * @param {string} pTransactionGUID - The transaction GUID, if any.
+	 * @returns {boolean} - Returns true.
+	 */
+	onEvent(pView, pInput, pValue, pHTMLSelector, pEvent, pTransactionGUID)
+	{
+		const tmpResult = super.onEvent(pView, pInput, pValue, pHTMLSelector, pEvent, pTransactionGUID);
+		if (typeof pEvent !== "string")
+		{
+			return tmpResult;
+		}
+		const tmpEventParts = pEvent.split(':');
+		const tmpEventHash = tmpEventParts[0];
+		if (tmpEventHash !== 'GetPickList')
+		{
+			return tmpResult;
+		}
+		const tmpListHash = tmpEventParts[1];
+		if (tmpListHash !== pInput.PictForm.SelectOptionsPickList)
+		{
+			return tmpResult;
+		}
+		const tmpListDataAddress = tmpEventParts[2];
+		const tmpEventOptions = JSON.parse(tmpEventParts.slice(3).join(':'));
+		this.pict.log.info(`CustomSelectInputProvider received event: ${pEvent} for list ${tmpListHash} with options:`, { tmpEventHash, tmpListHash, tmpListDataAddress, tmpEventOptions });
+		const tmpListData = this.pict.manifest.getValueByHash(this.pict, tmpListDataAddress);
+		if (!Array.isArray(tmpListData))
+		{
+			this.pict.log.error(`CustomSelectInputProvider expected array data at address ${tmpListDataAddress} but found:`, { tmpListData });
+			return tmpResult;
+		}
+		if (tmpListData.length > 0)
+		{
+			return tmpResult;
+		}
+		for (let i = 0; i < 10; ++i)
+		{
+			const tmpRandomNumber = Math.floor(Math.random() * 1000);
+			tmpListData.push({ id: `random-${tmpRandomNumber}`, text: `${tmpRandomNumber}` });
+		}
+
+		return tmpResult;
+	}
+}
+
 class ComplexTabularApplication extends libPictSectionForm.PictFormApplication
 {
 	constructor(pFable, pOptions, pServiceHash)
@@ -16,6 +72,12 @@ class ComplexTabularApplication extends libPictSectionForm.PictFormApplication
 		this.pict.AppData.UI.StatisticsTabState = "FruitStatistics";
 		this.pict.addProvider('CustomDataProvider', libCustomDataProvider.default_configuration, libCustomDataProvider);
 	}
+
+	onInitialize()
+	{
+		this.pict.addProvider('Pict-Input-Select', CustomSelectInputProvider.default_configuration, CustomSelectInputProvider);
+		return super.onInitialize();
+	}
 }
 
 module.exports = ComplexTabularApplication;
@@ -67,7 +129,11 @@ module.exports.default_configuration.pict_configuration = {
 					IDTemplate: "{~D:Record.IDBook~}",
 					Sorted: true,
 					UpdateFrequency: "Always",
-				}
+				},
+				{
+					Hash: "RandomNumbers",
+					Dynamic: true,
+				},
 			],
 
 		Sections: [
@@ -200,6 +266,12 @@ module.exports.default_configuration.pict_configuration = {
 		],
 
 		Descriptors: {
+			RandomNumber: {
+				Name: "Pick a Random Number",
+				Hash: "PickRandomNumber",
+				DataType: "String",
+				PictForm: { Section: "Recipe", Group: "Recipe", Row: 1, InputType: "Option", SelectOptionsPickList: "RandomNumbers" },
+			},
 			RecipeName: {
 				Name: "Recipe Name",
 				Hash: "RecipeName",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-section-form",
-    "version": "1.0.165",
+    "version": "1.0.166",
     "description": "Pict dynamic form sections",
     "main": "source/Pict-Section-Form.js",
     "directories": {
@@ -45,7 +45,7 @@
         "chart.js": "^4.5.1",
         "fable-serviceproviderbase": "^3.0.15",
         "marked": "^15.0.12",
-        "pict-provider": "^1.0.6",
+        "pict-provider": "^1.0.7",
         "pict-section-tuigrid": "^1.0.27",
         "pict-template": "^1.0.13",
         "pict-view": "^1.0.64"

package/source/providers/Pict-Provider-MetaLists.js

@@ -30,7 +30,7 @@ class PictMetalist extends libPictProvider
 
 		/** @type {any} */
 		this.options;
-		/** @type {import('pict')} */
+		/** @type {import('pict') & { log: any, instantiateServiceProviderWithoutRegistration: (hash: String) => any, instantiateServiceProviderIfNotExists: (hash: string) => any, TransactionTracking: import('pict/types/source/services/Fable-Service-TransactionTracking') }} */
 		this.pict;
 		/** @type {import('pict')} */
 		this.fable;
@@ -44,15 +44,31 @@ class PictMetalist extends libPictProvider
 		this.computedLists = {};
 		this.listDefinitions = {};
 	}
+	/** @typedef {{ id: string, text: string }} PickListItem */
 
 	/**
 	 * Retrieves a list based on the provided view hash and list hash.
 	 *
 	 * @param {string} pListHash - The list hash.
-	 * @returns {Array} - The retrieved list.
+	 * @param {Object} [pOptions={}] - (optional) Additional options for retrieving the list. (ex. search term)
+	 *
+	 * @returns {Array<PickListItem>} - The retrieved list.
 	 */
-	getList(pListHash)
+	getList(pListHash, pOptions = {})
 	{
+		if (this.listDefinitions[pListHash].Dynamic)
+		{
+			const tmpList = [];
+			const tmpTransactionGUID = this.pict.getUUID();
+			const tmpHash = tmpTransactionGUID.substring(0, 8);
+			const tmpAddress = `AppData._MetaLists.${tmpHash}`;
+			this.pict.manifest.setValueByHash(this.pict, tmpAddress, tmpList);
+			this.pict.TransactionTracking.registerTransaction(tmpTransactionGUID);
+			this.pict.views.PictFormMetacontroller.triggerGlobalInputEvent(`GetPickList:${pListHash}:${tmpAddress}:${JSON.stringify(pOptions)}`, tmpTransactionGUID);
+			this.pict.views.PictFormMetacontroller.finalizeTransaction(tmpTransactionGUID);
+			delete this.pict.AppData._MetaLists[tmpHash];
+			return tmpList;
+		}
 		if (pListHash in this.computedLists)
 		{
 			return this.computedLists[pListHash];

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

@@ -5,19 +5,30 @@ export = PictMetalist;
 declare class PictMetalist extends libPictProvider {
     /** @type {any} */
     options: any;
-    /** @type {import('pict')} */
-    pict: import("pict");
+    /** @type {import('pict') & { log: any, instantiateServiceProviderWithoutRegistration: (hash: String) => any, instantiateServiceProviderIfNotExists: (hash: string) => any, TransactionTracking: import('pict/types/source/services/Fable-Service-TransactionTracking') }} */
+    pict: import("pict") & {
+        log: any;
+        instantiateServiceProviderWithoutRegistration: (hash: string) => any;
+        instantiateServiceProviderIfNotExists: (hash: string) => any;
+        TransactionTracking: import("pict/types/source/services/Fable-Service-TransactionTracking");
+    };
     /** @type {import('pict')} */
     fable: import("pict");
     computedLists: {};
     listDefinitions: {};
+    /** @typedef {{ id: string, text: string }} PickListItem */
     /**
      * Retrieves a list based on the provided view hash and list hash.
      *
      * @param {string} pListHash - The list hash.
-     * @returns {Array} - The retrieved list.
+     * @param {Object} [pOptions={}] - (optional) Additional options for retrieving the list. (ex. search term)
+     *
+     * @returns {Array<PickListItem>} - The retrieved list.
      */
-    getList(pListHash: string): any[];
+    getList(pListHash: string, pOptions?: any): Array<{
+        id: string;
+        text: string;
+    }>;
     /**
      * Checks if a list exists in the Pict Provider MetaLists.
      *

package/types/source/providers/Pict-Provider-MetaLists.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Pict-Provider-MetaLists.d.ts","sourceRoot":"","sources":["../../../source/providers/Pict-Provider-MetaLists.js"],"names":[],"mappings":";AAaA;;GAEG;AACH;IAcE,kBAAkB;IAClB,SADW,GAAG,CACF;IACZ,6BAA6B;IAC7B,MADW,OAAO,MAAM,CAAC,CAChB;IACT,6BAA6B;IAC7B,OADW,OAAO,MAAM,CAAC,CACf;IAQV,kBAAuB;IACvB,oBAAyB;IAG1B;;;;;OAKG;IACH,mBAHW,MAAM,SAUhB;IAED;;;;;OAKG;IACH,mBAHW,MAAM,GACJ,OAAO,CAKnB;IAED;;;OAGG;IACH,iDAsBC;IAED;;;;OAIG;IACH,6BAFW,MAAM,QAQhB;IAED;;;;OAIG;IACH,qCAwGC;CACD;;;;;AA9ND,kCAAkC;AAClC,6CADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAS3B"}
+{"version":3,"file":"Pict-Provider-MetaLists.d.ts","sourceRoot":"","sources":["../../../source/providers/Pict-Provider-MetaLists.js"],"names":[],"mappings":";AAaA;;GAEG;AACH;IAcE,kBAAkB;IAClB,SADW,GAAG,CACF;IACZ,6QAA6Q;IAC7Q,MADW,OAAO,MAAM,CAAC,GAAG;QAAE,GAAG,EAAE,GAAG,CAAC;QAAC,6CAA6C,EAAE,CAAC,IAAI,QAAQ,KAAK,GAAG,CAAC;QAAC,qCAAqC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;QAAC,mBAAmB,EAAE,OAAO,8DAA8D,CAAC,CAAA;KAAE,CAChQ;IACT,6BAA6B;IAC7B,OADW,OAAO,MAAM,CAAC,CACf;IAQV,kBAAuB;IACvB,oBAAyB;IAE1B,2DAA2D;IAE3D;;;;;;;OAOG;IACH,mBALW,MAAM,mBAGJ,KAAK;YARE,MAAM;cAAQ,MAAM;MAQR,CAsB/B;IAED;;;;;OAKG;IACH,mBAHW,MAAM,GACJ,OAAO,CAKnB;IAED;;;OAGG;IACH,iDAsBC;IAED;;;;OAIG;IACH,6BAFW,MAAM,QAQhB;IAED;;;;OAIG;IACH,qCAwGC;CACD;;;;;AA9OD,kCAAkC;AAClC,6CADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAS3B"}

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

@@ -9,7 +9,7 @@ declare class PictMetatemplateGenerator extends libPictProvider {
     /** @type {libPictViewDynamicForm} */
     dynamicInputView: libPictViewDynamicForm;
     baseTemplatePrefix: string;
-    onInitializeAsync(fCallback: any): any;
+    onInitializeAsync(fCallback: any): void;
     createOnDemandMetatemplateView(): void;
     /**
      * Retrieves the metatemplate template reference in raw format.

package/types/source/providers/Pict-Provider-MetatemplateGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Pict-Provider-MetatemplateGenerator.d.ts","sourceRoot":"","sources":["../../../source/providers/Pict-Provider-MetatemplateGenerator.js"],"names":[],"mappings":";AAkDA;;;GAGG;AACH;IAcE,6BAA6B;IAC7B,MADW,OAAO,MAAM,CAAC,CAChB;IAIT,qCAAqC;IACrC,kBADW,sBAAsB,CACZ;IAErB,2BAAwC;IAGzC,uCAIC;IAED,uCAYC;IAED;;;;;;;OAOG;IACH,kEAJW,MAAM,2BACN,MAAM,GACJ,MAAM,CAmBlB;IAED;;;;;;;OAOG;IACH,+DAJW,MAAM,oBACN,MAAM,GACJ,MAAM,CAKlB;IAED;;;;;;;;OAQG;IACH,6DALW,MAAM,cACN,MAAM,oBACN,MAAM,GACJ,MAAM,CA4BlB;IAED;;;;;;;;;;OAUG;IACH,oEAPW,MAAM,cACN,MAAM,oBACN,MAAM,eACN,MAAM,aACN,MAAM,GACJ,MAAM,CAqDlB;IAED;;;;;;;;OAQG;IACH,qEALW,MAAM,cACN,MAAM,oBACN,MAAM,GACJ,MAAM,CA4BlB;IAED;;;;;;OAMG;IACH,qDA2BC;IAED;;;;;;OAMG;IACH,wCA8BC;CACD;;;;;;AA3VD,kCAAkC;AAClC,6CADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAS3B"}
+{"version":3,"file":"Pict-Provider-MetatemplateGenerator.d.ts","sourceRoot":"","sources":["../../../source/providers/Pict-Provider-MetatemplateGenerator.js"],"names":[],"mappings":";AAkDA;;;GAGG;AACH;IAcE,6BAA6B;IAC7B,MADW,OAAO,MAAM,CAAC,CAChB;IAIT,qCAAqC;IACrC,kBADW,sBAAsB,CACZ;IAErB,2BAAwC;IAGzC,wCAIC;IAED,uCAYC;IAED;;;;;;;OAOG;IACH,kEAJW,MAAM,2BACN,MAAM,GACJ,MAAM,CAmBlB;IAED;;;;;;;OAOG;IACH,+DAJW,MAAM,oBACN,MAAM,GACJ,MAAM,CAKlB;IAED;;;;;;;;OAQG;IACH,6DALW,MAAM,cACN,MAAM,oBACN,MAAM,GACJ,MAAM,CA4BlB;IAED;;;;;;;;;;OAUG;IACH,oEAPW,MAAM,cACN,MAAM,oBACN,MAAM,eACN,MAAM,aACN,MAAM,GACJ,MAAM,CAqDlB;IAED;;;;;;;;OAQG;IACH,qEALW,MAAM,cACN,MAAM,oBACN,MAAM,GACJ,MAAM,CA4BlB;IAED;;;;;;OAMG;IACH,qDA2BC;IAED;;;;;;OAMG;IACH,wCA8BC;CACD;;;;;;AA3VD,kCAAkC;AAClC,6CADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAS3B"}