@gen3/core 0.12.54 → 0.12.55

package/dist/dts/features/facets/types.d.ts

@@ -1,21 +1,88 @@
 import { IndexAndField } from '../guppy/types';
+/**
+ * The type of facet
+ * Drives which facet UI control is rendered and how values are formatted.
+ *
+ * @category Facets
+ */
 export type FacetType = 'enum' | 'exact' | 'range' | 'age' | 'age_in_years' | 'year' | 'years' | 'days' | 'percent' | 'numeric_range' | 'datetime' | 'toggle' | 'multiselect' | 'upload';
+/**
+ * The inclusive numeric bounds a range facet may filter within.
+ *
+ * @category Facets
+ */
 export interface AllowableRange {
+    /** Lowest selectable value. */
     readonly minimum: number;
+    /** Highest selectable value. */
     readonly maximum: number;
+    /**
+     * Increment between selectable values on the range control.
+     *
+     * @defaultValue `1`
+     */
     readonly step?: number;
 }
+/**
+ * Describes a single facet: the field it filters, its classified type, and the
+ * options that control how it is displayed and which values are shown.
+ *
+ * @category Facets
+ */
 export interface FacetDefinition {
+    /**
+     * Human-readable description sourced from the Elasticsearch `_mapping`.
+     */
     readonly description?: string;
+    /**
+     * Fully-qualified name of the field this facet filters.
+     */
     readonly field: string;
+    /**
+     * @deprecated Use {@link FacetDefinition.field} instead.
+     */
     readonly dataField?: string;
+    /**
+     * Index (data type) this facet belongs to.
+     */
     readonly index: string;
+    /**
+     * Classified facet type used to pick the rendering control.
+     *
+     * @remarks Derived from the field's data type and name — e.g. `age`,
+     * `year`, `enum`.
+     */
     readonly type: FacetType;
+    /**
+     * Allowed bounds for range-style facets.
+     *
+     * @remarks Only meaningful when {@link FacetDefinition.type} is a range kind.
+     */
     readonly range?: AllowableRange;
+    /**
+     * Whether this facet currently has any data to display.
+     */
     readonly hasData?: boolean;
+    /**
+     * Display label shown in the UI; falls back to the field name when unset.
+     */
     readonly label?: string;
+    /**
+     * Other indices this filter is denormalized across, so a selection applies
+     * consistently everywhere the field appears.
+     */
     readonly sharedWithIndices?: Array<IndexAndField>;
+    /**
+     * Values pinned to the bottom of the facet's value list.
+     */
     readonly moveValuesToBottom?: Array<string>;
+    /**
+     * Values omitted from the facet entirely.
+     */
     readonly excludeValues?: Array<string>;
+    /**
+     * Overrides the per-value label rendered for this facet when set.
+     */
+    readonly valueLabel?: string;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/dts/features/facets/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/features/facets/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,OAAO,GACP,OAAO,GACP,KAAK,GACL,cAAc,GACd,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,eAAe,GACf,UAAU,GACV,QAAQ,GACR,aAAa,GACb,QAAQ,CAAC;AAEb,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAClD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/features/facets/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,OAAO,GACP,OAAO,GACP,KAAK,GACL,cAAc,GACd,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,eAAe,GACf,UAAU,GACV,QAAQ,GACR,aAAa,GACb,QAAQ,CAAC;AAEb;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B"}

package/dist/index.d.ts

@@ -19261,24 +19261,91 @@ type DRSHostnameMap = Record<string, string>;
 declare const drsHostnamesReducer: redux.Reducer<Record<string, string>>;
 declare const setDRSHostnames: _reduxjs_toolkit.ActionCreatorWithPayload<DRSHostnameMap, "drsResolver/setDRSHostnames">;
 
+/**
+ * The type of facet
+ * Drives which facet UI control is rendered and how values are formatted.
+ *
+ * @category Facets
+ */
 type FacetType = 'enum' | 'exact' | 'range' | 'age' | 'age_in_years' | 'year' | 'years' | 'days' | 'percent' | 'numeric_range' | 'datetime' | 'toggle' | 'multiselect' | 'upload';
+/**
+ * The inclusive numeric bounds a range facet may filter within.
+ *
+ * @category Facets
+ */
 interface AllowableRange {
+    /** Lowest selectable value. */
     readonly minimum: number;
+    /** Highest selectable value. */
     readonly maximum: number;
+    /**
+     * Increment between selectable values on the range control.
+     *
+     * @defaultValue `1`
+     */
     readonly step?: number;
 }
+/**
+ * Describes a single facet: the field it filters, its classified type, and the
+ * options that control how it is displayed and which values are shown.
+ *
+ * @category Facets
+ */
 interface FacetDefinition {
+    /**
+     * Human-readable description sourced from the Elasticsearch `_mapping`.
+     */
     readonly description?: string;
+    /**
+     * Fully-qualified name of the field this facet filters.
+     */
     readonly field: string;
+    /**
+     * @deprecated Use {@link FacetDefinition.field} instead.
+     */
     readonly dataField?: string;
+    /**
+     * Index (data type) this facet belongs to.
+     */
     readonly index: string;
+    /**
+     * Classified facet type used to pick the rendering control.
+     *
+     * @remarks Derived from the field's data type and name — e.g. `age`,
+     * `year`, `enum`.
+     */
     readonly type: FacetType;
+    /**
+     * Allowed bounds for range-style facets.
+     *
+     * @remarks Only meaningful when {@link FacetDefinition.type} is a range kind.
+     */
     readonly range?: AllowableRange;
+    /**
+     * Whether this facet currently has any data to display.
+     */
     readonly hasData?: boolean;
+    /**
+     * Display label shown in the UI; falls back to the field name when unset.
+     */
     readonly label?: string;
+    /**
+     * Other indices this filter is denormalized across, so a selection applies
+     * consistently everywhere the field appears.
+     */
     readonly sharedWithIndices?: Array<IndexAndField>;
+    /**
+     * Values pinned to the bottom of the facet's value list.
+     */
     readonly moveValuesToBottom?: Array<string>;
+    /**
+     * Values omitted from the facet entirely.
+     */
     readonly excludeValues?: Array<string>;
+    /**
+     * Overrides the per-value label rendered for this facet when set.
+     */
+    readonly valueLabel?: string;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gen3/core",
-  "version": "0.12.54",
+  "version": "0.12.55",
   "author": "CTDS",
   "description": "Core module for Gen3.2. Packages provides an interface for interacting with the gen3 API, various types, and a redux store for managing state.",
   "license": "Apache-2.0",
@@ -79,5 +79,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "015017307b0e32075242e663877c69f3f2f9a409"
+  "gitHead": "5937ccf08cb698195cf86916f1835cc2cd2f8ebe"
 }