@cobre-npm/ds-v3 0.126.3 → 0.126.4

package/dist/types/components/organisms/CobreAccountPicker/CobreAccountPicker.vue.d.ts

@@ -1,4 +1,10 @@
 import { type CobreSelectableItem } from '../../molecules/CobreAccountOptionSelect/CobreAccountOptionSelect.vue';
+/**
+ * CobreAccountPicker — a button-style trigger that displays the currently
+ * selected account/counterparty (or a placeholder) and emits `click` to open a
+ * picker dialog. Use as the entry point for choosing a source/destination
+ * account in a flow; pair it with your own list/modal to perform the selection.
+ */
 interface Props {
     label: string;
     placeholderText: string;

package/dist/types/components/organisms/CobreDateFilter/CobreDateFilter.vue.d.ts

@@ -5,6 +5,13 @@ interface ParsedDate {
     date_lte: Date | string | [Date, Date] | null;
     type: CalendarTypes;
 }
+/**
+ * CobreDateFilter — a chip-triggered dropdown date filter built on the vue
+ * datepicker. Lets the user pick a single date, a range, or a relative shortcut
+ * (today, lastN, after, before), emitting the resolved `date_gte`/`date_lte`
+ * bounds. Use in table/list toolbars to filter records by date.
+ * Exposes `clearDate()`; provides a `header-content` slot above the calendar.
+ */
 interface Props {
     modelValue: null | {
         date_gte: Date | string | [Date, Date] | null;

package/dist/types/components/organisms/CobreDynamicForm/CobreDynamicForm.vue.d.ts

@@ -1,5 +1,12 @@
 import type { ComputedRef } from 'vue';
 import type { Field } from './interfaces/field.interface';
+/**
+ * CobreDynamicForm — renders a form from a declarative `fields` array, mapping
+ * each field's `type` to the matching Cobre input (input, date, select,
+ * currency, phone, radio, url, checkbox). Use to build configurable forms
+ * without hand-wiring each control; only fields with `visible: true` are shown.
+ * Exposes `isFormValid` and `reset()`; emits `field-updated` on every change.
+ */
 type __VLS_Props = {
     fields: Field[];
     formId: string;

package/dist/types/components/organisms/CobreFilterPanel/CobreFilterPanel.vue.d.ts

@@ -1,4 +1,12 @@
 import type { Filter } from './interfaces/filter.interface';
+/**
+ * CobreFilterPanel — a two-pane filter popover: a left tab list (one per
+ * filter) and the active filter's control on the right, rendered from the
+ * declarative `filters` array (checkbox, radio, input, amount-range, select).
+ * Use to filter a table/list by several dimensions at once; the parent owns
+ * filter values/state via the `filter-updated`/`filter-search`/`filter-cleared`
+ * events. Exposes `areFiltersValid()` and `reset()`.
+ */
 interface Props {
     filters?: Filter[];
     isOpen?: boolean;

package/dist/types/components/organisms/CobreFilterPanel/components/FilterAmountRange.vue.d.ts

@@ -1,4 +1,10 @@
 import type { AmountRangeFilter, AmountRangeValue } from '../interfaces/filter.interface';
+/**
+ * FilterAmountRange — the amount-range control for CobreFilterPanel: a pair of
+ * from/to amount inputs that emit the updated `{ from, to }` value. Validates
+ * that `from` does not exceed `to` and surfaces the filter's error message.
+ * Rendered internally by CobreFilterPanel for `amount-range` filters; exposes `isValid`.
+ */
 type __VLS_Props = {
     filter: AmountRangeFilter;
 };

package/dist/types/components/organisms/CobreFilterPanel/components/FilterCheckboxList.vue.d.ts

@@ -1,4 +1,10 @@
 import type { CheckboxFilter } from '../interfaces/filter.interface';
+/**
+ * FilterCheckboxList — the checkbox-group control for CobreFilterPanel: renders
+ * one checkbox per option and emits the updated array of selected values when
+ * an option is toggled. Options may carry a `logoURL` for an inline icon.
+ * Rendered internally by CobreFilterPanel for `checkbox` filters.
+ */
 type __VLS_Props = {
     filter: CheckboxFilter;
 };

package/dist/types/components/organisms/CobreFilterPanel/components/FilterInput.vue.d.ts

@@ -1,4 +1,10 @@
 import type { InputFilter } from '../interfaces/filter.interface';
+/**
+ * FilterInput — the free-text control for CobreFilterPanel: a single CobreInput
+ * that emits its string value and surfaces the filter's validation error.
+ * Honors the filter's inputType, placeholder, and min/max length.
+ * Rendered internally by CobreFilterPanel for `input` filters.
+ */
 type __VLS_Props = {
     filter: InputFilter;
 };

package/dist/types/components/organisms/CobreFilterPanel/components/FilterRadioList.vue.d.ts

@@ -1,4 +1,10 @@
 import type { RadioFilter } from '../interfaces/filter.interface';
+/**
+ * FilterRadioList — the single-select radio-group control for CobreFilterPanel:
+ * renders one radio per option and emits the chosen value on selection.
+ * Options may carry a `logoURL` for an inline icon.
+ * Rendered internally by CobreFilterPanel for `radio` filters.
+ */
 type __VLS_Props = {
     filter: RadioFilter;
 };

package/dist/types/components/organisms/CobreFilterPanel/components/FilterSelect.vue.d.ts

@@ -1,4 +1,10 @@
 import type { SelectFilter } from '../interfaces/filter.interface';
+/**
+ * FilterSelect — the dropdown control for CobreFilterPanel: wraps CobreSelect
+ * and emits the chosen value (or array when `multiple`). Honors the filter's
+ * placeholder, searchable, clearable, multiple, reduce, and optionLabel props.
+ * Rendered internally by CobreFilterPanel for `select` filters.
+ */
 type __VLS_Props = {
     filter: SelectFilter;
 };

package/dist/types/components/organisms/CobreHeader/CobreHeader.vue.d.ts

@@ -9,6 +9,13 @@ export interface MenuItem {
     icon?: string;
     subItems?: Items[];
 }
+/**
+ * CobreHeader — top application bar for the Cobre platform.
+ * Use as the page header; on mobile it toggles a hamburger menu that renders the
+ * `menu` entries via the Navbar component. For the persistent desktop side
+ * navigation use CobreSideMenu instead.
+ * Provides `start` (left, e.g. logo) and `end` (right, e.g. avatar/actions) slots.
+ */
 interface Props {
     menu: MenuItem[];
     menuItemActive: string;

package/dist/types/components/organisms/CobreHeader/components/Navbar.vue.d.ts

@@ -9,6 +9,11 @@ interface Menu {
     highlight?: boolean;
     subItems?: SubItems[];
 }
+/**
+ * Navbar — the navigation list rendered inside CobreHeader's mobile menu.
+ * Renders each `menu` entry; entries with subItems become collapsible groups
+ * that expand on tap. Not used standalone — driven by CobreHeader.
+ */
 interface Props {
     menu: Menu[];
     itemActive: string;

package/dist/types/components/organisms/CobreSideMenu/CobreSideMenu.vue.d.ts

@@ -1,4 +1,10 @@
 import type { MenuItem } from './interfaces/menu.interface';
+/**
+ * CobreSideMenu — persistent vertical navigation rail for the Cobre platform.
+ * Renders top and bottom item groups, supports a collapsed (icon-only) state and
+ * expandable sub-pages. For the mobile/top application bar use CobreHeader instead.
+ * Provides `header` (top branding area), `start`, and `end` slots.
+ */
 interface Props {
     itemsTop: MenuItem[];
     itemActive: string;

package/dist/types/components/organisms/CobreSideMenu/components/SideMenuItem.vue.d.ts

@@ -1,4 +1,10 @@
 import type { MenuItem } from '../interfaces/menu.interface';
+/**
+ * SideMenuItem — renders one group of CobreSideMenu entries with their sub-items.
+ * Each entry shows an icon and label; entries with subItems expand on hover
+ * (inline when expanded, as a floating panel when collapsed). Driven by
+ * CobreSideMenu, not used standalone.
+ */
 interface Props {
     items: MenuItem[] | undefined;
     itemActive: string;

package/dist/types/components/organisms/CobreSideMenu/components/SubItems.vue.d.ts

@@ -1,4 +1,9 @@
 import type { Items } from '../interfaces/menu.interface';
+/**
+ * SubItems — renders the nested sub-entries of a CobreSideMenu item as a list.
+ * Each sub-item is a selectable menu button; emits selectSubItem on click.
+ * Driven by SideMenuItem, not used standalone.
+ */
 interface Props {
     subItems: Items[];
     itemActive: string;

package/dist/types/components/organisms/CobreTimeline/CobreTimeline.vue.d.ts

@@ -1,3 +1,8 @@
+/**
+ * CobreTimeline — a vertical, ordered list of events connected by a line.
+ * Use to show chronological steps or status history; each event renders an icon
+ * and title plus a scoped `item` slot (exposing `item`) for custom content.
+ */
 interface Item {
     [key: string]: any;
     iconClass?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobre-npm/ds-v3",
-  "version": "0.126.3",
+  "version": "0.126.4",
   "type": "module",
   "packageManager": "pnpm@11.0.4",
   "engines": {