pict-section-recordset 1.0.57 → 1.0.59

package/test/PictSectionRecordSet-RecordProvider-Meadow_tests.js

@@ -1,11 +1,10 @@
 /*
 	Unit tests for PictSectionRecordSet Basic
-	
+
 */
 
 // This is temporary, but enables unit tests
 const libBrowserEnv = require('browser-env');
-libBrowserEnv();
 
 const libPictApplication = require('pict-application');
 const libPictView = require('pict-view');
@@ -59,7 +58,10 @@ suite
 	'PictSectionRecordSet RecordProvider MeadowEndpoints Tests',
 	() =>
 	{
-		setup(() => { });
+		setup(() =>
+		{
+			libBrowserEnv({ url: 'http://localhost/' });
+		});
 
 		suite
 			(

package/types/application/Pict-Application-RecordSet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Pict-Application-RecordSet.d.ts","sourceRoot":"","sources":["../../source/application/Pict-Application-RecordSet.js"],"names":[],"mappings":";AAOA;;;;;;;GAOG;AACH;IAEC,2DAiBC;CAwBD;;;;;qCAIU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC"}
+{"version":3,"file":"Pict-Application-RecordSet.d.ts","sourceRoot":"","sources":["../../source/application/Pict-Application-RecordSet.js"],"names":[],"mappings":";AASA;;;;;;;GAOG;AACH;IAEC,2DAqBC;CAwBD;;;;;qCAIU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC"}

package/types/providers/Filter-Data-Provider.d.ts

@@ -1,4 +1,44 @@
 export = FilterDataProvider;
+/** Terminology for Filter Data Provider (to avoid confusion):
+ * A "Record Set" is a collection of records that can be filtered.
+ * A "Filter Experience" is a saved state of filters for a given record set.
+ * A "Filter Experience Hash" is a unique identifier for a Filter Experience (display name converted to a hash).
+ * A "Filter Experience Encoded URL Param" is the URL-encoded representation of the filter state for a Filter Experience.
+ * A "Filter Display Name" is a user-friendly name for a Filter Experience to select/view in the UI.
+ * A "Filter Clauses" is a list of all saved filters in the "Filter Experience" for a given Record Set.
+ * A "Filter Meta" is the metadata associated with a Filter Experience, including the Filter Clauses and Filter Display Name.
+
+ * Behavior Summary:
+ * - Save Filter Meta to LocalStorage under a key derived from Record Set, View Context, and Filter Experience Hash.
+ * - Load Filter Meta from LocalStorage using the same key.
+ * - Remove Filter Meta from LocalStorage when requested.
+ * - List all Filter Experiences for a given Record Set by scanning LocalStorage keys.
+ * - Manage default and last used Filter Experiences for each Record Set and View Context. (last used takes priority over default on load, if the check is enabled)
+
+ * Storage Key Structure:
+ * - Filter_Meta_{RecordSet}_{ViewContext}_{FilterExperienceHash} : stores the Filter Meta JSON.
+
+ * Object Shape for Filter Meta (filter experience):
+ * {
+ *   RecordSet: string, (auto-filled on save)
+ *   ViewContext: string, (auto-filled on save)
+ *   LastModifiedDate: string (ISO date) (auto-filled on save)
+ *   FilterClauses: Array<{ Label: string, ExactMatch: boolean, Value: string }>,
+ *   FilterDisplayName: string,
+ *   FilterExperienceHash: string, (display name converted to hash)
+ *   FilterExperienceEncodedURLParam: string, (URL-encoded filter state)
+ 
+ * Object Shape for Filter Experience Settings:
+ * {
+ *   ExcludedFromSelection: boolean,
+ *   RememberLastUsedFilterExperience: boolean,
+ *   LastUsedFilterExperienceHash: string | null,
+ *   LastUsedFilterExperienceURLParam: string | null,
+ *   DefaultFilterExperienceHash: string | null,
+ *   DefaultFilterExperienceURLParam: string | null,
+ *   FallbackDefaultExperienceURLParam: string | null,
+ * }
+*/
 declare class FilterDataProvider extends libPictProvider {
     /**
      * @param {import('pict')} pFable - The Fable instance
@@ -8,91 +48,225 @@ declare class FilterDataProvider extends libPictProvider {
     constructor(pFable: import("pict"), pOptions?: Record<string, any>, pServiceHash?: string);
     storageProvider: any;
     keyCache: {};
-    filtersMap: {};
-    lastFilterExperienceHashMap: {};
+    /** ===== UTILITY for Filter Experience ============= */
     /**
-     * @return {void}
+     * Using the information in the FilterClauses, try to generate a contextual default filter name for the display name of the current experience.
+     *
+     * @param {object} pFilterExperience - The filter experience to generate the default filter name for
+     * @param {string} [pRecordSet] - The current record set
+     * @param {string} [pViewContext] - The current view context
+     * @return {string} - The generated default filter name
      */
-    loadFilters(): void;
+    generateContextualDefaultFilterName(pFilterExperience: object, pRecordSet?: string, pViewContext?: string): string;
     /**
-     * List all available Filters (from the Filter Meta data)
-     *
-     * @param {string} pRecordSet - the record set to list the filters for
-     *
-     * @return Array<Record<string, any>> - a list of Filters as Index/FilterExperienceHash entries
+     * Re-render all views affected by a filter change.
+     * @param {object} tmpFilterExperience - The filter meta record that was changed/added.
+     * @param {string} pRecordSet - The record set to check.
+     * @param {string} pViewContext - The current view context
      */
-    listFilters(pRecordSet: string): any;
+    navigateToFilterExperienceRoute(tmpFilterExperience: object, pRecordSet: string, pViewContext: string): void;
     /**
-     * @param {string} pRecordSet - the record set to get the active filter experience for
-     *
-     * @return {Record<string, any>} - the active filter experience for the given record set
+     * Apply the expected filter experience to load on application load for a given record set and view context. Last Used takes priority over Default.
+     * This is the main entry point to set the default/latest filter experience on app load for a given record set and view context.
+     * @param {string} pRecordSet - The record set to set the default filter experience for
+     * @param {string} pViewContext - The current view context
+     * @return {boolean} - Returns true when the default filter experience has been set
      */
-    getActiveFilterExperience(pRecordSet: string): Record<string, any>;
+    applyExpectedFilterExperience(pRecordSet: string, pViewContext: string): boolean;
+    /** ===== CRUD Filter Experiences ============= */
     /**
-     * Check if a particular scope is in use.
-     *
-     * @param {string} pRecordSet - the record set
-     * @param {string} pFilterExperienceHash - the manyfest scope to check the existence of
-     *
-     * @return {boolean}
+     * Initialize the filter experience settings for a given record set and view context if they do not already exist.
+     * @param {string} pRecordSet - The record set to initialize the settings for
+     * @param {string} pViewContext - The current view context
+     * @param {object} [pAdditionalSettings] - Additional settings to initialize with (pass through for future use)
+     * @return {string} - The filter experience settings object stringifyed (as if it was just read from storage).
+     */
+    initializeFilterExperienceSettings(pRecordSet: string, pViewContext: string, pAdditionalSettings?: object): string;
+    /**
+     * Set options like Last Used / Default hashes, which are stored in the settings object for a given record set and view context.
+     * @param {string} pRecordSet - The record set to get the setting for
+     * @param {string} pViewContext - The current view context
+     * @param {object} pSettings - The settings to update
+     * @return {object} - The filter experience settings object
+     */
+    updateFilterExperienceSettingsFromStorage(pRecordSet: string, pViewContext: string, pSettings: object): object;
+    /**
+     * Get a single filter experience by its hash for a given record set and view context.
+     * @param {string} pRecordSet - The record set to get the filter experience for
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The filter experience hash to get
+     * @return {object} - The filter experience object
+     */
+    getFilterExperienceByHash(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): object;
+    /**
+     * List all available filter experiences (from the Filter Meta data) for a given record set and return them as an array of filter meta objects.
+     * @param {string} pRecordSet - the record set to list the filter experiences for
+     * @param {string} pViewContext - the current view context
+     * @return {Array<object>} - An array of filter meta objects for the given record set.
      */
-    checkFilterExists(pRecordSet: string, pFilterExperienceHash: string): boolean;
+    getAllFiltersExperiencesForRecordSet(pRecordSet: string, pViewContext: string): Array<object>;
     /**
      * Resolve a key in the LocalStorage keyspace for a filter experience for a given record set.
-     *
      * @param {string} pRecordSet - The record set to resolve a key for
+     * @param {string} pViewContext - The current view context
      * @param {string} pFilterExperienceHash - The scope to resolve a key for
      *
      * @return {string} A string that points to the record.
      */
-    getFilterStorageKey(pRecordSet: string, pFilterExperienceHash: string): string;
+    getFilterStorageKey(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): string;
+    /**
+     * Check if a filter experience exists for a given record set and filter experience hash.
+     * @param {string} pRecordSet - The record set to check.
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The filter experience hash to check.
+     * @return {boolean} - True if the filter experience exists, false otherwise.
+     */
+    checkIfFilterExperienceExists(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): boolean;
     /**
      * Save the application metadata (list of Filters, last loaded FilterExperienceHash, etc.)
-     *
-     * @param {string} pRecordSet - The record set to save the filter for; TODO: should this have a default?
-     * @param {boolean} [pRender=false] - Whether or not to also render the list of Filters in the UI automatically
+     * @param {string} pRecordSet - The record set to save the filter for;
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The name of the filter to load
+     * @param {boolean} pSkipSaveAsLastUsed - Whether to skip saving this as the last used filter experience - useful when loading last used filter itself
+     * @return {boolean} - Returns true when the filter experience has been loaded.
+     */
+    loadFilterMeta(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string, pSkipSaveAsLastUsed: boolean): boolean;
+    /**
+     * Remove a filter meta from storage for a given record set and filter experience hash.
+     * @param {string} pRecordSet - The record set to remove the filter for
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The filter experience hash to remove
+     * @return {boolean} - Returns true when the filter meta has been removed.
      */
-    saveFilterMeta(pRecordSet: string, pRender?: boolean): boolean;
+    removeFilterMeta(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): boolean;
     /**
      * Save the application metadata (list of Filters, last loaded FilterExperienceHash, etc.)
-     *
      * @param {string} pRecordSet - The record set to save the filter for; TODO: should this have a default?
-     * @param {boolean} [pRender=false] - Whether or not to also render the list of Filters in the UI automatically
-     *
-     * @return {Array<object>} The list of available Filters.
+     * @param {string} pViewContext - The current view context
+     * @return {boolean} - Returns true when the settings have been saved.
      */
-    loadFilterMeta(pRecordSet: string, pRender?: boolean): Array<object>;
+    saveFilterMeta(pRecordSet: string, pViewContext: string): boolean;
+    /** ===== LAST USED Filter Experience ============= */
     /**
-     * @param {string} pRecordSet - The record set to add the filter experience hash to
-     * @param {string} pFilterExperienceHash - The filter experience hash to add
-     * @param {boolean} [pRender=true] - Whether or not to also render the list of Filters in the UI automatically
-     *
-     * @return {boolean} True if the filter experience hash was added, false if it already exists.
+     * Save the application metadata as the last used filter experience (continually updated).
+     * @param {object} pFilterExperience - The new filter experience object to save as last used
+     * @param {string} pRecordSet - The record set to save the filter for;
+     * @param {string} pViewContext - The current view context
+     * @return {boolean} - Returns true when the filter experience has been saved.
      */
-    addFilterExperienceHashToFilterList(pRecordSet: string, pFilterExperienceHash: string, pRender?: boolean): boolean;
+    setLastUsedFilterExperience(pFilterExperience: object, pRecordSet: string, pViewContext: string): boolean;
     /**
-     * @param {string} pRecordSet - The record set to remove the filter experience hash from
-     * @param {string} pFilterExperienceHash - The filter experience hash to remove
-     * @param {boolean} [pRender=true] - Whether or not to also render the list of Filters in the UI automatically
+     * Remove the last used filter experience for a given record set and view context. (used on "Clear" action to get back to empty filter state)
+     * @param {string} pRecordSet - The record set to remove the last used filter experience for
+     * @param {string} pViewContext - The current view context
+     * @return {boolean} - Returns true when the last used filter experience has been removed.
      */
-    removeFilterExperienceHashFromFilterList(pRecordSet: string, pFilterExperienceHash: string, pRender?: boolean): boolean;
+    removeLastUsedFilterExperience(pRecordSet: string, pViewContext: string): boolean;
     /**
-     * @param {string} pRecordSet - The record set to create a new filter for
-     * @param {string} [pFilterExperienceHash] - The filter experience hash to create a new filter for; if not provided, a new one will be generated
+     * Get the last used filter experience for a given record set and view context.
+     * @param {string} pRecordSet - The record set to get the last used filter experience for
+     * @param {string} pViewContext - The current view context
+     * @return {object} - The last used filter experience (takes priority over default if both exist)
      */
-    newFilter(pRecordSet: string, pFilterExperienceHash?: string): void;
+    getLastUsedFilterExperience(pRecordSet: string, pViewContext: string): object;
     /**
-     * @param {string} pRecordSet - The record set to save the filter for; TODO: should this have a default?
+     * Check if the given filter experience is the last used filter experience for the given record set and view context.
+     * @param {string} pRecordSet - The record set to check
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The filter experience hash to check
+     * @return {boolean} - True if the given filter experience is the last used filter experience, false otherwise
+     */
+    isLastUsedFilterExperienceHash(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): boolean;
+    /**
+     * Set whether to remember the last used filter experience across sessions.
+     * @param {string} pRecordSet - The record set to set the setting for
+     * @param {string} pViewContext - The current view context
+     * @param {boolean} pRemember - Whether to remember the last used filter experience
+     */
+    setRememberLastUsedFilterExperience(pRecordSet: string, pViewContext: string, pRemember: boolean): boolean;
+    /**
+     * Get whether to remember the last used filter experience across sessions.
+     * @param {string} pRecordSet - The record set to get the setting for
+     * @param {string} pViewContext - The current view context
+     * @return {boolean} - Whether to remember the last used filter experience
+     */
+    getRememberLastUsedFilterExperience(pRecordSet: string, pViewContext: string): boolean;
+    /** ===== CURRENT Filter Experience ============= */
+    /**
+     * Check if the given filter experience hash is the current active filter for the given record set.
+     * @param {string} pRecordSet - The record set to check.
+     * @param {string} pViewContext - The current view context.
+     * @param {string} pFilterExperienceHash - The filter experience hash to check.
+     * @return {boolean} - True if the given filter experience hash is the current active filter, false otherwise.
+     */
+    isCurrentFilterExperience(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): boolean;
+    /**
+     * Get the current filter name from the UI input (or generate a default one)
+     * @param {object} pFilterExperience - The filter experience to get the current filter name for
+     * @param {string} pRecordSet - The record set to get the filter name for
+     * @param {string} pViewContext - The current view context
+     * @return {string} - The current filter name
      */
-    saveFilter(pRecordSet: string): void;
+    getCurrentFilterName(pFilterExperience: object, pRecordSet: string, pViewContext: string): string;
     /**
-     * @param {string} pRecordSet - The record set to load the filter for
-     * @param {string} pFilterFilterExperienceHash - The filter experience hash to load; if not provided, the last used one will be loaded
+     * Set the current filter name in the UI input
+     * @param {object} [pFilterExperience] - The filter experience to set the current filter name for
+     * @param {string} [pRecordSet] - The record set to set the filter name for
+     * @param {string} [pViewContext] - The current view context
+     * @param {string} [pNewName] - The new name to set
+     * @return {boolean} - Returns true when the name has been set
      */
-    loadFilter(pRecordSet: string, pFilterFilterExperienceHash: string): void;
+    setCurrentFilterName(pFilterExperience?: object, pRecordSet?: string, pViewContext?: string, pNewName?: string): boolean;
+    /** ===== DEFAULT Filter Experience ============= */
+    /**
+     * Set the default filter experience to load on application load for a given record set and filter experience hash.
+     * @param {string} pRecordSet - The record set to set the default filter experience for
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The filter experience hash to set as default on load
+     * @param {boolean} pSetAsDefault - Whether to set as default or not
+     * @return {boolean} - Returns true when the default filter experience has been set
+     */
+    setDefaultFilterExperience(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string, pSetAsDefault: boolean): boolean;
+    /**
+     * Remove the default filter experience for a given record set and view context. (used on "Clear" action to get back to empty filter state)
+     * @param {string} pRecordSet - The record set to remove the default filter experience for
+     * @param {string} pViewContext - The current view context
+     * @return {boolean} - Returns true when the default filter experience has been removed.
+     */
+    removeDefaultFilterExperience(pRecordSet: string, pViewContext: string): boolean;
+    /**
+     * Get the default filter experience to load on application load for a given record set and view context.
+     * @param {string} pRecordSet - The record set to get the default filter experience for
+     * @param {string} pViewContext - The current view context
+     * @return {object} - The default filter experience to load on application load (used if no last used filter experience is found or they clear filters back to default)
+     */
+    getDefaultFilterExperience(pRecordSet: string, pViewContext: string): object;
+    /**
+     * Check if the given filter experience is the default filter experience to load on application load for the given record set and view context.
+     * @param {string} pRecordSet - The record set to check
+     * @param {string} pViewContext - The current view context
+     * @param {string} pFilterExperienceHash - The filter experience hash to check
+     * @return {boolean} - True if the given filter experience is the default filter experience on load, false otherwise
+     */
+    isDefaultFilterExperience(pRecordSet: string, pViewContext: string, pFilterExperienceHash: string): boolean;
+    /**
+     * Get the fallback default filter experience URL param to load on application load for a given record set and view context.
+     * @param {string} pRecordSet - The record set to get the fallback default filter experience for
+     * @param {string} pViewContext - The current view context
+     * @return {string|null} - The fallback default filter experience URL param to load on application load (could be server/customer provided)
+     */
+    getFallbackDefaultFilterExperienceSettings(pRecordSet: string, pViewContext: string): string | null;
+    /**
+     * Set the fallback default filter experience URL param to load on application load for a given record set and view context. Expected to be used for server/customer provided fallbacks.
+     * @param {string} pRecordSet - The record set to set the fallback default filter experience for
+     * @param {string} pViewContext - The current view context
+     * @param {string} pURLParam - The fallback default filter experience URL param to set
+     * @return {boolean} - Returns true when the fallback default filter experience URL param has been set
+     */
+    setFallbackDefaultFilterExperienceSettings(pRecordSet: string, pViewContext: string, pURLParam: string): boolean;
+    /** ===== SIMPLE KEY-VALUE CACHE ============= */
     /**
      * @param {string} pKey - The key to get from the cache
-     *
      * @return {any} - The value associated with the key, or false if not found
      */
     getItem(pKey: string): any;
@@ -103,7 +277,6 @@ declare class FilterDataProvider extends libPictProvider {
     setItem(pKey: string, pValue: any): boolean;
     /**
      * @param {string} pKey - The key to remove from the cache
-     *
      * @return {boolean} - True if the item was removed, false if it was not found
      */
     removeItem(pKey: string): boolean;

package/types/providers/Filter-Data-Provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Filter-Data-Provider.d.ts","sourceRoot":"","sources":["../../source/providers/Filter-Data-Provider.js"],"names":[],"mappings":";AAUA;IAEC;;;;OAIG;IACH,oBAJW,OAAO,MAAM,CAAC,aACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,iBACnB,MAAM,EAiBhB;IATA,qBAA2B;IAC3B,aAAkB;IAMlB,eAAqB;IACrB,gCAAsC;IAUvC;;OAEG;IACH,eAFY,IAAI,CAKf;IAED;;;;;;OAMG;IACH,wBAJW,MAAM,OAUhB;IAED;;;;OAIG;IACH,sCAJW,MAAM,GAEL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAK9B;IAED;;;;;;;OAOG;IACH,8BALW,MAAM,yBACN,MAAM,GAEL,OAAO,CAgBlB;IAED;;;;;;;OAOG;IACH,gCALW,MAAM,yBACN,MAAM,GAEL,MAAM,CAQjB;IAED;;;;;OAKG;IACH,2BAHW,MAAM,YACN,OAAO,WAejB;IAED;;;;;;;OAOG;IACH,2BALW,MAAM,YACN,OAAO,GAEN,KAAK,CAAC,MAAM,CAAC,CA6BxB;IAED;;;;;;OAMG;IACH,gDANW,MAAM,yBACN,MAAM,YACN,OAAO,GAEN,OAAO,CA4BlB;IAED;;;;OAIG;IACH,qDAJW,MAAM,yBACN,MAAM,YACN,OAAO,WAoCjB;IAED;;;OAGG;IACH,sBAHW,MAAM,0BACN,MAAM,QAoDhB;IAED;;OAEG;IACH,uBAFW,MAAM,QAQhB;IAED;;;OAGG;IACH,uBAHW,MAAM,+BACN,MAAM,QAUhB;IAED;;;;OAIG;IACH,cAJW,MAAM,GAEL,GAAG,CASd;IAED;;;OAGG;IACH,cAHW,MAAM,UACN,GAAG,WAMb;IAED;;;;OAIG;IACH,iBAJW,MAAM,GAEL,OAAO,CAUlB;CACD"}
+{"version":3,"file":"Filter-Data-Provider.d.ts","sourceRoot":"","sources":["../../source/providers/Filter-Data-Provider.js"],"names":[],"mappings":";AASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuCE;AAIF;IAEC;;;;OAIG;IACH,oBAJW,OAAO,MAAM,CAAC,aACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,iBACnB,MAAM,EAchB;IANA,qBAA2B;IAC3B,aAAkB;IAYnB,wDAAwD;IAExD;;;;;;;OAOG;IACH,uDALW,MAAM,eACN,MAAM,iBACN,MAAM,GACL,MAAM,CAqBjB;IAED;;;;;OAKG;IACH,qDAJW,MAAM,cACN,MAAM,gBACN,MAAM,QAchB;IAED;;;;;;OAMG;IACH,0CAJW,MAAM,gBACN,MAAM,GACL,OAAO,CA+ClB;IAED,kDAAkD;IAElD;;;;;;OAMG;IACH,+CALW,MAAM,gBACN,MAAM,wBACN,MAAM,GACL,MAAM,CA6BjB;IAED;;;;;;OAMG;IACH,sDALW,MAAM,gBACN,MAAM,aACN,MAAM,GACL,MAAM,CAoBjB;IAED;;;;;;OAMG;IACH,sCALW,MAAM,gBACN,MAAM,yBACN,MAAM,GACL,MAAM,CAkBjB;IAED;;;;;OAKG;IACH,iDAJW,MAAM,gBACN,MAAM,GACL,KAAK,CAAC,MAAM,CAAC,CAkBxB;IAED;;;;;;;OAOG;IACH,gCANW,MAAM,gBACN,MAAM,yBACN,MAAM,GAEL,MAAM,CAWjB;IAED;;;;;;OAMG;IACH,0CALW,MAAM,gBACN,MAAM,yBACN,MAAM,GACL,OAAO,CAOlB;IAED;;;;;;;OAOG;IACH,2BANW,MAAM,gBACN,MAAM,yBACN,MAAM,uBACN,OAAO,GACN,OAAO,CAkClB;IAED;;;;;;OAMG;IACH,6BALW,MAAM,gBACN,MAAM,yBACN,MAAM,GACL,OAAO,CAkClB;IAED;;;;;OAKG;IACH,2BAJW,MAAM,gBACN,MAAM,GACL,OAAO,CA8BlB;IAED,sDAAsD;IAEtD;;;;;;OAMG;IACH,+CALW,MAAM,cACN,MAAM,gBACN,MAAM,GACL,OAAO,CAgBlB;IAED;;;;;OAKG;IACH,2CAJW,MAAM,gBACN,MAAM,GACL,OAAO,CAMlB;IAED;;;;;OAKG;IACH,wCAJW,MAAM,gBACN,MAAM,GACL,MAAM,CAmBjB;IAED;;;;;;OAMG;IACH,2CALW,MAAM,gBACN,MAAM,yBACN,MAAM,GACL,OAAO,CAUlB;IAED;;;;;OAKG;IACH,gDAJW,MAAM,gBACN,MAAM,aACN,OAAO,WAMjB;IAED;;;;;OAKG;IACH,gDAJW,MAAM,gBACN,MAAM,GACL,OAAO,CAWlB;IAED,oDAAoD;IAEpD;;;;;;OAMG;IACH,sCALW,MAAM,gBACN,MAAM,yBACN,MAAM,GACL,OAAO,CAclB;IAED;;;;;;OAMG;IACH,wCALW,MAAM,cACN,MAAM,gBACN,MAAM,GACL,MAAM,CAWjB;IAED;;;;;;;OAOG;IACH,yCANW,MAAM,eACN,MAAM,iBACN,MAAM,aACN,MAAM,GACL,OAAO,CAOlB;IAED,oDAAoD;IAEpD;;;;;;;OAOG;IACH,uCANW,MAAM,gBACN,MAAM,yBACN,MAAM,iBACN,OAAO,GACN,OAAO,CA4BlB;IAED;;;;;OAKG;IACH,0CAJW,MAAM,gBACN,MAAM,GACL,OAAO,CAMlB;IAED;;;;;OAKG;IACH,uCAJW,MAAM,gBACN,MAAM,GACL,MAAM,CAiBjB;IAED;;;;;;OAMG;IACH,sCALW,MAAM,gBACN,MAAM,yBACN,MAAM,GACL,OAAO,CAWlB;IAED;;;;;OAKG;IACH,uDAJW,MAAM,gBACN,MAAM,GACL,MAAM,GAAC,IAAI,CAWtB;IAED;;;;;;OAMG;IACH,uDALW,MAAM,gBACN,MAAM,aACN,MAAM,GACL,OAAO,CAMlB;IAED,iDAAiD;IAEjD;;;OAGG;IACH,cAHW,MAAM,GACL,GAAG,CASd;IAED;;;OAGG;IACH,cAHW,MAAM,UACN,GAAG,WAMb;IAED;;;OAGG;IACH,iBAHW,MAAM,GACL,OAAO,CAUlB;CACD"}

package/types/views/Filter-PersistenceView.d.ts

@@ -0,0 +1,104 @@
+export = viewFilterPersistenceView;
+declare class viewFilterPersistenceView extends libPictView {
+    constructor(pFable: any, pOptions: any, pServiceHash: any);
+    currentRecordSet: string;
+    currentViewContext: string;
+    filterExperienceSelection: any;
+    /**
+     * Toggles the filter persistence UI for a given record set and view context.
+     * @param {string} pRecordSet - The identifier of the record set.
+     * @param {string} pViewContext - The context of the view.
+     * @returns {boolean} - Returns true when the UI has been toggled.
+     */
+    openFilterPersistenceUI(pRecordSet: string, pViewContext: string): boolean;
+    /**
+     * Updates the filter experience settings for a given record set and view context.
+     * @param {string} pRecordSet - The identifier of the record set.
+     * @param {string} pViewContext - The context of the view.
+     * @param {object} pSettings - The settings to update.
+     * @returns {boolean} - Returns true when the settings have been updated.
+     */
+    updateFilterExperienceSettings(pRecordSet: string, pViewContext: string, pSettings: object): boolean;
+    /**
+     * Sets the filter experience to load based on user selection.
+     * @param {Event} event - The event object.
+     * @returns {boolean} - Returns true when the filter experience has been set.
+     */
+    setFilterExperienceToSelection(event: Event): boolean;
+    /**
+     * Closes the filter persistence UI.
+     * @returns {boolean} - Returns true when the UI has been closed.
+     */
+    closeFilterPersistenceUI(): boolean;
+    /**
+     * Builds the select options for available filter experiences. Sets the current filter as selected and indicates it in the option text.
+     * @returns {boolean} - Returns true when the options have been built.
+     */
+    buildSelectOptionsForAvailableFilterExperiences(): boolean;
+    /**
+     * Toggles the "Remember Last Used Filter Experience" setting in the Filter Data Provider.
+     * @param {Event} event - The event object.
+     * @returns {boolean} - Returns true when the setting has been toggled.
+     */
+    toggleRememberLastUsedFilterExperience(event: Event): boolean;
+    /**
+     * Loads the filter persistence settings for the current selection of filter experiences.
+     * @param {Event} event - The event object.
+     * @returns {boolean} - Returns true when the settings have been loaded.
+     */
+    loadFilterPersistenceSettings(event: Event): boolean;
+    /**
+     * Saves the filter persistence settings for the current selection of filter experiences.
+     * @param {Event} event - The event object.
+     * @returns {boolean} - Returns true when the settings have been saved.
+     */
+    saveFilterPersistenceSettings(event: Event): boolean;
+    /**
+     * Sets the filter experience as the default for the current record set and view context.
+     * @param {Event} event - The event object.
+     * @param {boolean} isDefault - Whether to set as default or not.
+     * @returns {boolean} - Returns true when the settings have been set as default.
+     */
+    toggleFilterExperienceAsTheDefault(event: Event, isDefault: boolean): boolean;
+    /**
+     * Handles the button states for the filter experience selection.
+     * @param {boolean} isDefault - Whether the filter experience is set as default or not.
+     */
+    handleSelectionButtonStates(isDefault: boolean): void;
+    /**
+     * Deletes the filter persistence settings for the current selection of filter experiences.
+     * @param {Event} event - The event object.
+     * @returns {boolean} - Returns true when the settings have been deleted.
+     */
+    deleteFilterPersistenceSettings(event: Event): boolean;
+}
+declare namespace viewFilterPersistenceView {
+    export { _DEFAULT_CONFIGURATION_FilterPersistenceView as default_configuration };
+}
+import libPictView = require("pict-view");
+declare namespace _DEFAULT_CONFIGURATION_FilterPersistenceView {
+    let ViewIdentifier: string;
+    let DefaultRenderable: string;
+    let DefaultDestinationAddress: string;
+    let DefaultTemplateRecordAddress: boolean;
+    let AutoInitialize: boolean;
+    let AutoInitializeOrdinal: number;
+    let AutoRender: boolean;
+    let AutoRenderOrdinal: number;
+    let AutoSolveWithApp: boolean;
+    let AutoSolveOrdinal: number;
+    let CSS: boolean;
+    let CSSPriority: number;
+    let Templates: {
+        Hash: string;
+        Template: string;
+    }[];
+    let Renderables: {
+        RenderableHash: string;
+        TemplateHash: string;
+        DestinationAddress: string;
+        RenderMethod: string;
+    }[];
+    let Manifests: {};
+}
+//# sourceMappingURL=Filter-PersistenceView.d.ts.map

package/types/views/Filter-PersistenceView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Filter-PersistenceView.d.ts","sourceRoot":"","sources":["../../source/views/Filter-PersistenceView.js"],"names":[],"mappings":";AAoFA;IAEC,2DAQC;IAHA,yBAA4B;IAC5B,2BAA8B;IAC9B,+BAAqC;IAGtC;;;;;OAKG;IACH,oCAJW,MAAM,gBACN,MAAM,GACJ,OAAO,CA4CnB;IAED;;;;;;OAMG;IACH,2CALW,MAAM,gBACN,MAAM,aACN,MAAM,GACJ,OAAO,CAenB;IAED;;;;OAIG;IACH,sCAHW,KAAK,GACH,OAAO,CAuBnB;IAED;;;OAGG;IACH,4BAFa,OAAO,CAanB;IAED;;;OAGG;IACH,mDAFa,OAAO,CAsCnB;IAED;;;;OAIG;IACH,8CAHW,KAAK,GACH,OAAO,CAcnB;IAED;;;;OAIG;IACH,qCAHW,KAAK,GACH,OAAO,CAenB;IAED;;;;OAIG;IACH,qCAHW,KAAK,GACH,OAAO,CAWnB;IAED;;;;;OAKG;IACH,0CAJW,KAAK,aACL,OAAO,GACL,OAAO,CAoBnB;IAED;;;OAGG;IACH,uCAFW,OAAO,QA4BjB;IAED;;;;OAIG;IACH,uCAHW,KAAK,GACH,OAAO,CAiBnB;CACD"}

package/types/views/RecordSet-Filters.d.ts

@@ -25,13 +25,11 @@ declare class ViewRecordSetSUBSETFilters extends libPictView {
     getInformaryScopedValue(pAddress: string): any;
     /**
      * Marshals data from the view to the model, usually AppData (or configured data store).
-     *
      * @returns {any} The result of the superclass's onMarshalFromView method.
      */
     onMarshalFromView(): any;
     /**
      * Marshals the data to the view from the model, usually AppData (or configured data store).
-     *
      * @returns {any} The result of the super.onMarshalToView() method.
      */
     onMarshalToView(): any;
@@ -48,31 +46,68 @@ declare class ViewRecordSetSUBSETFilters extends libPictView {
      */
     performSearch(pRecordSet: string, pViewContext: string, pFilterString?: string): void;
     /**
+     * Clear all filter clauses for the given record set and view context.
+     * @param {Event} pEvent - The DOM event that triggered the search
+     * @param {string} pRecordSet - The record set being filtered
+     * @param {string} pViewContext - The view context for the filter (ex. List, Dashboard)
+     */
+    handleClear(pEvent: Event, pRecordSet: string, pViewContext: string): void;
+    /**
+     * Reset the filters to default state or fallback to to clear everything if no default exist for the given record set and view context.
      * @param {Event} pEvent - The DOM event that triggered the search
      * @param {string} pRecordSet - The record set being filtered
      * @param {string} pViewContext - The view context for the filter (ex. List, Dashboard)
      */
     handleReset(pEvent: Event, pRecordSet: string, pViewContext: string): void;
+    /**
+     * @param {Event} pEvent - The DOM event that triggered the search
+     * @param {string} pRecordSet - The record set being filtered
+     * @param {string} pViewContext - The view context for the filter (ex. List, Dashboard)
+     * @returns {boolean} - Always returns false to prevent default action
+    */
+    handleManage(pEvent: Event, pRecordSet: string, pViewContext: string): boolean;
     /**
      * @param {Event} pEvent - The DOM event that triggered the search
      * @param {string} pRecordSet - The record set being filtered
      * @param {string} pViewContext - The view context for the filter (ex. List, Dashboard)
      */
     selectFilterToAdd(pEvent: Event, pRecordSet: string, pViewContext: string): void;
-    addFilter(pEvent: any, pRecordSet: any, pViewContext: any, pFilterKey: any, pClauseKey: any): void;
-    removeFilter(pEvent: any, pRecordSet: any, pViewContext: any, pSpecificFilterKey: any): void;
-    getFilterSchema(pRecordSet: any): any[];
-    serializeFilterExperience(pExperience: any): Promise<string>;
     /**
+     * @param {Event} pEvent - The DOM event that triggered the search
+     * @param {string} pRecordSet - The record set being filtered
+     * @param {string} pViewContext - The view context for the filter (ex. List, Dashboard)
+     * @param {string} pFilterKey - The key of the filter to add
+     * @param {string} pClauseKey - The key of the clause to add
+     */
+    addFilter(pEvent: Event, pRecordSet: string, pViewContext: string, pFilterKey: string, pClauseKey: string): void;
+    /**
+     * @param {Event} pEvent - The DOM event that triggered the search
+     * @param {string} pRecordSet - The record set being filtered
+     * @param {string} pViewContext - The view context for the filter (ex. List, Dashboard)
+     * @param {string} pSpecificFilterKey - The key of the specific filter to remove
+     */
+    removeFilter(pEvent: Event, pRecordSet: string, pViewContext: string, pSpecificFilterKey: string): void;
+    /**
+     * Gets the filter schema for the given record set.
+     * @param {string} pRecordSet - The record set to get the filter schema for
+     * @return {Array<any>} - The filter schema for the given record set
+     */
+    getFilterSchema(pRecordSet: string): Array<any>;
+    /**
+     * Encodes the filter experience to a string.
+     * @param {Record<string, any>} pExperience - The filter experience to serialize.
+     * @return {Promise<string>} - The serialized filter experience as a string.
+     */
+    serializeFilterExperience(pExperience: Record<string, any>): Promise<string>;
+    /**
+     * Decodes the filter experience from a string.
      * @param {string} pExperience - The serialized filter experience as a string.
-     *
      * @return {Promise<Record<string, any>>} - The serialized filter experience as a string.
      */
     deserializeFilterExperience(pExperience: string): Promise<Record<string, any>>;
     /**
      * @param {string} string - The string to compress.
      * @param {CompressionFormat} [encoding='gzip'] - The encoding to use for compression, defaults to 'gzip'.
-     *
      * @return {Promise<ArrayBuffer>} - The compressed byte array.
      */
     compress(string: string, encoding?: CompressionFormat): Promise<ArrayBuffer>;
@@ -83,13 +118,11 @@ declare class ViewRecordSetSUBSETFilters extends libPictView {
     decompress(byteArray: Uint8Array, encoding?: CompressionFormat): Promise<string>;
     /**
      * @param {ArrayBuffer} arraybuffer - The ArrayBuffer to encode to Base64.
-     *
      * @return {string} - The Base64 encoded string.
      */
     encode(arraybuffer: ArrayBuffer): string;
     /**
      * @param {string} base64 - The Base64 encoded string to decode to an ArrayBuffer.
-     *
      * @return {ArrayBuffer} - The decoded ArrayBuffer.
      */
     decode(base64: string): ArrayBuffer;

package/types/views/RecordSet-Filters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filters.d.ts","sourceRoot":"","sources":["../../source/views/RecordSet-Filters.js"],"names":[],"mappings":";AAgMA;IAEC,2DA4BC;IAxBA,kHAAkH;IAClH,MADW,GAAe,GAAG,OAAO,MAAM,CAAC,GAAG;QAAE,oBAAoB,EAAE;;;;;;SAAsC,CAAA;KAAE,CACrG;IAeT,cAA+E;IAG/E,wCAA0E;IAO3E;;OAEG;IACH,6BAFY,MAAM,CAKjB;IAED;;;;OAIG;IACH,kCAJW,MAAM,GAEL,GAAG,CAMd;IAKD;;;;OAIG;IACH,qBAFa,GAAG,CAaf;IAED;;;;OAIG;IACH,mBAFa,GAAG,CAaf;IAED;;;;OAIG;IACH,qBAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAShB;IAED;;;;OAIG;IACH,0BAJW,MAAM,gBACN,MAAM,kBACN,MAAM,QAgDhB;IAED;;;;OAIG;IACH,oBAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAqBhB;IAED;;;;OAIG;IACH,0BAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAQhB;IAED,mGAOC;IAED,6FAOC;IAED,wCAIC;IA0CD,6DAeC;IAED;;;;OAIG;IACH,yCAJW,MAAM,GAEL,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAUvC;IAED;;;;;OAKG;IACH,iBALW,MAAM,aACN,iBAAiB,GAEhB,OAAO,CAAC,WAAW,CAAC,CAU/B;IAED;;;OAGG;IACH,sBAHW,UAAU,aACV,iBAAiB,mBAY3B;IAED;;;;OAIG;IACH,oBAJW,WAAW,GAEV,MAAM,CA2BjB;IAED;;;;OAIG;IACH,eAJW,MAAM,GAEL,WAAW,CAsCtB;CACD;;;;;AA5kBD,kCAAkC;AAClC,oDADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAgJ5B"}
+{"version":3,"file":"RecordSet-Filters.d.ts","sourceRoot":"","sources":["../../source/views/RecordSet-Filters.js"],"names":[],"mappings":";AA6MA;IAEC,2DA4BC;IAxBA,kHAAkH;IAClH,MADW,GAAe,GAAG,OAAO,MAAM,CAAC,GAAG;QAAE,oBAAoB,EAAE;;;;;;SAAsC,CAAA;KAAE,CACrG;IAeT,cAA+E;IAG/E,wCAA0E;IAO3E;;OAEG;IACH,6BAFY,MAAM,CAKjB;IAED;;;;OAIG;IACH,kCAJW,MAAM,GAEL,GAAG,CAMd;IAKD;;;OAGG;IACH,qBAFa,GAAG,CAaf;IAED;;;OAGG;IACH,mBAFa,GAAG,CAaf;IAED;;;;OAIG;IACH,qBAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAShB;IAED;;;;OAIG;IACH,0BAJW,MAAM,gBACN,MAAM,kBACN,MAAM,QAkDhB;IAED;;;;;OAKG;IACH,oBAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAShB;IAGD;;;;;OAKG;IACH,oBAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAkBhB;IAED;;;;;MAKE;IACF,qBALW,KAAK,cACL,MAAM,gBACN,MAAM,GACJ,OAAO,CAQnB;IAED;;;;OAIG;IACH,0BAJW,KAAK,cACL,MAAM,gBACN,MAAM,QAQhB;IAED;;;;;;OAMG;IACH,kBANW,KAAK,cACL,MAAM,gBACN,MAAM,cACN,MAAM,cACN,MAAM,QAShB;IAED;;;;;OAKG;IACH,qBALW,KAAK,cACL,MAAM,gBACN,MAAM,sBACN,MAAM,QAShB;IAED;;;;OAIG;IACH,4BAHW,MAAM,GACL,KAAK,CAAC,GAAG,CAAC,CAMrB;IAmDD;;;;OAIG;IACH,uCAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAClB,OAAO,CAAC,MAAM,CAAC,CAiB1B;IAED;;;;OAIG;IACH,yCAHW,MAAM,GACL,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAUvC;IAED;;;;OAIG;IACH,iBAJW,MAAM,aACN,iBAAiB,GAChB,OAAO,CAAC,WAAW,CAAC,CAU/B;IAED;;;OAGG;IACH,sBAHW,UAAU,aACV,iBAAiB,mBAa3B;IAED;;;OAGG;IACH,oBAHW,WAAW,GACV,MAAM,CA2BjB;IAED;;;OAGG;IACH,eAHW,MAAM,GACL,WAAW,CAsCtB;CACD;;;;;AAnpBD,kCAAkC;AAClC,oDADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA6J5B"}

package/types/views/filters/RecordSet-Filter-Base-Range.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filter-Base-Range.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-Base-Range.js"],"names":[],"mappings":";AAGA;CAkCC"}
+{"version":3,"file":"RecordSet-Filter-Base-Range.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-Base-Range.js"],"names":[],"mappings":";AAEA;CAoCC"}

package/types/views/filters/RecordSet-Filter-Base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filter-Base.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-Base.js"],"names":[],"mappings":";AAmEA;IAEC,2DAIC;IAED;;;;OAIG;IACH,uBAFW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QAe7B;IAED,gCAGC;IAED;;OAEG;IACH,6BAFY,MAAM,CAKjB;IAED;;;;OAIG;IACH,2CAJW,MAAM,GAEL,GAAG,CAKd;CACD;;;;;AAnHD,kCAAkC;AAClC,oDADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA+D5B"}
+{"version":3,"file":"RecordSet-Filter-Base.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-Base.js"],"names":[],"mappings":";AAmEA;IAEC,2DAIC;IAED;;;;OAIG;IACH,uBAFW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QAgB7B;IAED,gCAGC;IAED;;OAEG;IACH,6BAFY,MAAM,CAKjB;IAED;;;;OAIG;IACH,2CAJW,MAAM,GAEL,GAAG,CAKd;CACD;;;;;AApHD,kCAAkC;AAClC,oDADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA+D5B"}

package/types/views/filters/RecordSet-Filter-DateMatch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filter-DateMatch.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-DateMatch.js"],"names":[],"mappings":";AAqBA;CAuBC"}
+{"version":3,"file":"RecordSet-Filter-DateMatch.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-DateMatch.js"],"names":[],"mappings":";AAqBA;CAwBC"}

package/types/views/filters/RecordSet-Filter-DateRange.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filter-DateRange.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-DateRange.js"],"names":[],"mappings":";AAsBA;CAuCC"}
+{"version":3,"file":"RecordSet-Filter-DateRange.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-DateRange.js"],"names":[],"mappings":";AAsBA;CAyCC"}

package/types/views/filters/RecordSet-Filter-ExternalJoinDateMatch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filter-ExternalJoinDateMatch.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-ExternalJoinDateMatch.js"],"names":[],"mappings":";AAqBA;CAuBC"}
+{"version":3,"file":"RecordSet-Filter-ExternalJoinDateMatch.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-ExternalJoinDateMatch.js"],"names":[],"mappings":";AAqBA;CAwBC"}

package/types/views/filters/RecordSet-Filter-ExternalJoinDateRange.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecordSet-Filter-ExternalJoinDateRange.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-ExternalJoinDateRange.js"],"names":[],"mappings":";AAsBA;CAsBC"}
+{"version":3,"file":"RecordSet-Filter-ExternalJoinDateRange.d.ts","sourceRoot":"","sources":["../../../source/views/filters/RecordSet-Filter-ExternalJoinDateRange.js"],"names":[],"mappings":";AAsBA;CAwBC"}