pict-section-picker 1.0.0

package/types/Pict-Section-Picker.d.ts

@@ -0,0 +1,3 @@
+export = PictProviderPicker;
+import PictProviderPicker = require("./providers/Pict-Provider-Picker.js");
+//# sourceMappingURL=Pict-Section-Picker.d.ts.map

package/types/Pict-Section-Picker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pict-Section-Picker.d.ts","sourceRoot":"","sources":["../source/Pict-Section-Picker.js"],"names":[],"mappings":""}

package/types/providers/Pict-Provider-Picker.d.ts

@@ -0,0 +1,83 @@
+export = PictProviderPicker;
+/**
+ * The pict-section-picker provider — the primary API surface. Registers the widget CSS once and
+ * creates/manages picker view instances.
+ */
+declare class PictProviderPicker extends libPictProvider {
+    constructor(pFable: any, pOptions: any, pServiceHash: any);
+    /**
+     * Create (or reconfigure + reuse) a picker widget instance.
+     *
+     * @param {string} pPickerHash - A unique hash/id for this picker; the widget renders its control
+     *   into the DOM element `#<pPickerHash>` unless a DestinationAddress is given.
+     * @param {Record<string, any>} pConfig - Picker configuration:
+     *   - DestinationAddress {string} - CSS selector to render into (default `#<pPickerHash>`).
+     *   - ValueAddress {string} - AppData address the selection is read from / written to.
+     *   - Mode {'single'} - selection mode (multi/categories/creatable land in later phases).
+     *   - Placeholder {string} - text shown when nothing is selected.
+     *   - Searchable {boolean} - show the search box (default true).
+     *   - Options {Array<{Value:any, Text:string}>} - static option list.
+     *   - OnChange {function} - optional callback invoked with the new value after a selection.
+     * @return {any} The picker view instance.
+     */
+    createPicker(pPickerHash: string, pConfig: Record<string, any>): any;
+    /**
+     * Build the Meadow FoxHound filter for a search term across one or more fields.
+     *
+     * Single field → a clean AND-connected `FBV~Field~LK~%term%`. Multiple fields → the LIKEs are
+     * OR'd together inside a paren group (`FOP…FCP`) so the OR can't bleed into a sibling AND base
+     * filter. The term is `encodeURIComponent`-wrapped exactly as pict-section-recordset does, so the
+     * structural `~` separators stay literal in the URL path while the value is escaped.
+     *
+     * @param {Array<string>} pSearchFields - The entity fields to LIKE-match.
+     * @param {string} pTerm - The (raw) search term.
+     * @return {string} The FoxHound filter stanza(s).
+     */
+    buildSearchFilter(pSearchFields: Array<string>, pTerm: string): string;
+    /**
+     * Build an async picker DataProvider backed by a Meadow entity (via `pict.EntityProvider`).
+     * Returns a `(searchTerm, page) => Promise<{ results:[{Value,Text,Record}], hasMore }>` function —
+     * the exact contract PictViewPicker consumes for server search + pagination.
+     *
+     * @param {Record<string, any>} pConfig - Entity source configuration:
+     *   - Entity {string} (required) - the Meadow entity name (e.g. `Author`).
+     *   - SearchFields {Array<string>} - fields to LIKE-search (default `['Name']`).
+     *   - ValueField {string} - record field used as the option Value (default `ID<Entity>`).
+     *   - TextField {string} - record field used as the option Text (default `Name`).
+     *   - PageSize {number} - records per page (default 20).
+     *   - Sort {string} - optional field to sort ascending (adds `FSF~<field>~ASC~0`).
+     *   - BaseFilter {string} - optional always-applied FoxHound filter (AND), e.g. `FBV~IDCustomer~EQ~1`.
+     *   - MapRecord {function} - optional `(record) => {Value, Text}` mapper (overrides Value/TextField).
+     * @return {(pSearchTerm: string, pPage: number) => Promise<{results: Array<any>, hasMore: boolean}>}
+     */
+    createEntityDataProvider(pConfig: Record<string, any>): (pSearchTerm: string, pPage: number) => Promise<{
+        results: Array<any>;
+        hasMore: boolean;
+    }>;
+    /**
+     * Build a `ResolveValue(value) => Promise<{Value,Text}>` for an entity-backed picker, so a
+     * pre-bound ID resolves to its display text on first render (fetched + cached by `getEntity`).
+     *
+     * @param {Record<string, any>} pConfig - Same shape as {@link createEntityDataProvider}.
+     * @return {(pValue: any) => Promise<any>}
+     */
+    createEntityResolveValue(pConfig: Record<string, any>): (pValue: any) => Promise<any>;
+    /**
+     * Create a picker backed by a Meadow entity — the high-level entry point for the real
+     * lims/config/bridge entity pickers. Wires a server DataProvider + ResolveValue from `pConfig`
+     * and delegates to {@link createPicker}. Any picker option (DestinationAddress, ValueAddress,
+     * Placeholder, OnChange, …) may also be supplied and is passed through.
+     *
+     * @param {string} pPickerHash - Unique hash/id for this picker.
+     * @param {Record<string, any>} pConfig - {@link createEntityDataProvider} config + picker options.
+     * @return {any} The picker view instance.
+     */
+    createEntityPicker(pPickerHash: string, pConfig: Record<string, any>): any;
+}
+declare namespace PictProviderPicker {
+    export { _DEFAULT_CONFIGURATION as default_configuration };
+}
+import libPictProvider = require("pict-provider");
+/** @type {Record<string, any>} */
+declare const _DEFAULT_CONFIGURATION: Record<string, any>;
+//# sourceMappingURL=Pict-Provider-Picker.d.ts.map

package/types/providers/Pict-Provider-Picker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pict-Provider-Picker.d.ts","sourceRoot":"","sources":["../../source/providers/Pict-Provider-Picker.js"],"names":[],"mappings":";AAyEA;;;GAGG;AACH;IAEC,2DASC;IAED;;;;;;;;;;;;;;OAcG;IACH,0BAZW,MAAM,WAEN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAQlB,GAAG,CAqBd;IAED;;;;;;;;;;;OAWG;IACH,iCAJW,KAAK,CAAC,MAAM,CAAC,SACb,MAAM,GACL,MAAM,CAWjB;IAED;;;;;;;;;;;;;;;OAeG;IACH,kCAXW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GASlB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;QAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAC,CAAC,CAuCnG;IAED;;;;;;OAMG;IACH,kCAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAClB,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAsBxC;IAED;;;;;;;;;OASG;IACH,gCAJW,MAAM,WACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAClB,GAAG,CAQd;CACD;;;;;AA1LD,kCAAkC;AAClC,sCADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAO5B"}

package/types/views/PictView-Picker.d.ts

@@ -0,0 +1,110 @@
+export = PictViewPicker;
+declare class PictViewPicker extends libPictView {
+    constructor(pFable: any, pOptions: any, pServiceHash: any);
+    _StateAddress: string;
+    _open: boolean;
+    _search: string;
+    _highlight: number;
+    _loadedResults: any[];
+    _page: number;
+    _hasMore: boolean;
+    _loading: boolean;
+    _loaded: boolean;
+    _searchTimer: NodeJS.Timeout;
+    _selectedText: any;
+    _values: any[];
+    _selectedRecords: {};
+    /** @return {boolean} True when a DataProvider function is configured (async/server mode). */
+    _isAsync(): boolean;
+    /** @return {boolean} True when the picker is in multi-select (chips) mode. */
+    _isMulti(): boolean;
+    /** @return {Record<string, any>} The AppData state slot for this picker. */
+    _state(): Record<string, any>;
+    /** Resolve display text for any pre-bound value(s) via the async ResolveValue hook, then repaint. */
+    _resolveInitialValues(): void;
+    /**
+     * @return {any} The current selection: a scalar in single mode, or an array of values in multi mode
+     *   (normalizing a csv string or scalar at the bound address into an array).
+     */
+    getValue(): any;
+    /**
+     * Persist the selection to the bound address(es). Single mode writes the scalar; multi mode writes
+     * the array to ValueAddress and mirrors it to the optional csv / records addresses.
+     * @param {any} pValue - The new value (scalar in single mode, array in multi mode).
+     */
+    _setValue(pValue: any): void;
+    _value: any;
+    /** @return {Array<{Value:any, Text:string}>} The current option source rows (async results or static Options). */
+    _sourceRows(): Array<{
+        Value: any;
+        Text: string;
+    }>;
+    /**
+     * (Re)compute the picker's render state into AppData: the displayed value / chips + the
+     * (search-filtered) option list with selected/highlight flags.
+     */
+    _buildState(): Record<string, any>;
+    /**
+     * Find the {Value,Text} record for a value: the stored selection record (authoritative for chips /
+     * async), else a row in the current source (static Options or loaded results).
+     * @param {any} pValue
+     * @return {{Value:any, Text:string}|null}
+     */
+    _lookupRecord(pValue: any): {
+        Value: any;
+        Text: string;
+    } | null;
+    /**
+     * Load a page of results from the async DataProvider, accumulating (append) or replacing the list.
+     * @param {number} pPage - zero-based page index.
+     * @param {boolean} pAppend - true to append (Load more), false to replace (new search / first open).
+     */
+    _loadPage(pPage: number, pAppend: boolean): void;
+    /** Toggle the dropdown open/closed. */
+    toggle(pEvent: any): void;
+    /** Keyboard on the control: open the dropdown on Enter / Space / ArrowDown. */
+    onControlKey(pEvent: any): void;
+    /** Open the dropdown and focus the search box. */
+    open(): void;
+    /** Async mode: load + append the next page of results. */
+    loadMore(): void;
+    /** Close the dropdown. */
+    close(): void;
+    /** Reflect the open/closed state on the widget container. */
+    _paintOpen(): void;
+    /** Re-render only the option list (keeps the search input + its focus intact). */
+    _renderList(): void;
+    /** Re-render only the control's value area (the value span or the chips) — used in multi mode so
+     *  toggling a selection updates the chips without tearing down the open dropdown + search box. */
+    _renderValue(): void;
+    /** @param {string} pValue - Filter the option list by this search term. */
+    search(pValue: string): void;
+    /** Keyboard navigation within the search box: arrows highlight, Enter selects, Escape closes. */
+    onSearchKey(pEvent: any): void;
+    /**
+     * Select an option. Single mode: set the value + close. Multi mode: toggle the value in/out of the
+     * selection, keep the dropdown open, and refocus the search box for rapid multi-pick.
+     * @param {string} pValueKey - String(Value) of the option.
+     */
+    select(pValueKey: string): void;
+    /** @return {Array<{Value:any, Text:string}>} The full record list for the current multi selection. */
+    getSelectedRecords(): Array<{
+        Value: any;
+        Text: string;
+    }>;
+    /**
+     * Creatable: build a new option from the current search term via OnCreate, then select it (single:
+     * set + close; multi: add a chip). The created record is inserted into the source list so it shows
+     * as a normal, checked option.
+     */
+    createFromSearch(): void;
+    /** Multi mode: remove a selected value (chip ×). Keeps the dropdown state as-is. */
+    removeChip(pValueKey: any): void;
+}
+declare namespace PictViewPicker {
+    export { _DEFAULT_CONFIGURATION as default_configuration };
+}
+import libPictView = require("pict-view");
+/** @type {Record<string, any>} */
+declare const _DEFAULT_CONFIGURATION: Record<string, any>;
+//# sourceMappingURL=PictView-Picker.d.ts.map

package/types/views/PictView-Picker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PictView-Picker.d.ts","sourceRoot":"","sources":["../../source/views/PictView-Picker.js"],"names":[],"mappings":";AA6KA;IAEC,2DA0CC;IAlCA,sBAA2E;IAQ3E,eAAkB;IAClB,gBAAiB;IACjB,mBAAoB;IAEpB,sBAAwB;IACxB,cAAc;IACd,kBAAqB;IACrB,kBAAqB;IACrB,iBAAoB;IACpB,6BAAwB;IACxB,mBAAyB;IAGzB,eAAiB;IACjB,qBAA0B;IAc3B,6FAA6F;IAC7F,YADa,OAAO,CAInB;IAED,8EAA8E;IAC9E,YADa,OAAO,CAInB;IAED,4EAA4E;IAC5E,UADa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAM/B;IAED,qGAAqG;IACrG,8BA+BC;IAED;;;OAGG;IACH,YAHY,GAAG,CAgBd;IAED;;;;OAIG;IACH,kBAFW,GAAG,QA6Bb;IAvBC,YAAoB;IAyBtB,kHAAkH;IAClH,eADa,KAAK,CAAC;QAAC,KAAK,EAAC,GAAG,CAAC;QAAC,IAAI,EAAC,MAAM,CAAA;KAAC,CAAC,CAK3C;IAED;;;OAGG;IACH,mCAgGC;IAED;;;;;OAKG;IACH,sBAHW,GAAG,GACF;QAAC,KAAK,EAAC,GAAG,CAAC;QAAC,IAAI,EAAC,MAAM,CAAA;KAAC,GAAC,IAAI,CAQxC;IAED;;;;OAIG;IACH,iBAHW,MAAM,WACN,OAAO,QA4BjB;IAWD,uCAAuC;IACvC,0BAIC;IAED,+EAA+E;IAC/E,gCAWC;IAED,kDAAkD;IAClD,aAQC;IAED,0DAA0D;IAC1D,iBAMC;IAED,0BAA0B;IAC1B,cAKC;IAED,6DAA6D;IAC7D,mBAIC;IAED,kFAAkF;IAClF,oBAKC;IAED;sGACkG;IAClG,qBAKC;IAED,2EAA2E;IAC3E,eADY,MAAM,QAejB;IAED,iGAAiG;IACjG,+BAgCC;IAED;;;;OAIG;IACH,kBAFW,MAAM,QA4ChB;IAED,sGAAsG;IACtG,sBADa,KAAK,CAAC;QAAC,KAAK,EAAC,GAAG,CAAC;QAAC,IAAI,EAAC,MAAM,CAAA;KAAC,CAAC,CAI3C;IAED;;;;OAIG;IACH,yBA6CC;IAED,oFAAoF;IACpF,iCAWC;CAWD;;;;;AAxuBD,kCAAkC;AAClC,sCADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAyK5B"}