@ketvietlab/design-system 0.1.25 → 0.1.29

package/dist/interactions/search-filter/index.d.ts

@@ -0,0 +1,153 @@
+import type { IslandController, IslandProps } from '@ketvietlab/ketjs-view';
+export declare const HOOKS: readonly ['search-filter', 'search-filter-bar', 'search-filter-section-toggle', 'search-filter-sheet', 'search-filter-clear', 'search-filter-icon', 'search-filter-field', 'search-filter-input', 'search-filter-facets', 'search-filter-facet', 'search-filter-facet-remove', 'search-filter-suggestions', 'search-filter-suggestion', 'search-filter-toggle', 'search-filter-columns', 'search-filter-column', 'search-filter-column-title', 'search-filter-empty', 'search-filter-grouping', 'search-filter-grouping-head', 'search-filter-grouping-list', 'search-filter-grouping-item', 'search-filter-grouping-order', 'search-filter-grouping-label', 'search-filter-grouping-actions', 'search-filter-grouping-action', 'search-filter-grouping-clear', 'search-filter-grouping-add-label', 'custom-filter', 'custom-filter-row', 'custom-filter-add', 'custom-group-by', 'favorite-list', 'favorite-item', 'favorite-item-default', 'favorite-item-remove', 'favorite-save', 'favorite-save-toggle', 'favorite-save-row'];
+/**
+ * The same 7 field types and their operator vocabulary as
+ * `packages/ketjs/src/data/list-search.ts`'s `ListFieldType`/`defaultOperators` —
+ * redeclared here because design-system cannot depend on `@ketvietlab/ketjs`.
+ */
+export type SearchFilterFieldType = 'text' | 'number' | 'boolean' | 'selection' | 'reference' | 'date' | 'datetime';
+export type SearchFilterOperator = 'contains' | 'notContains' | 'equals' | 'notEquals' | 'startsWith' | 'gt' | 'gte' | 'lt' | 'lte' | 'between' | 'anyOf' | 'isTrue' | 'isFalse' | 'isSet' | 'isNotSet';
+/** The density of the search bar; `compact` uses the small control-height token. */
+export type SearchFilterSize = 'default' | 'compact';
+export type CustomFilterField = {
+    value: string;
+    label: string;
+    type: SearchFilterFieldType;
+    /** Screen-owned choices, including permission-checked reference lookups. */
+    choices?: readonly {
+        value: string;
+        label: string;
+    }[];
+};
+/** A removable chip in the search field. `type` only drives its colour token. */
+export type SearchFacet = {
+    id: string;
+    type: 'field' | 'filter' | 'groupBy' | 'favorite';
+    label: string;
+};
+export type SearchFilterOption = {
+    id: string;
+    label: string;
+    active: boolean;
+    /** Options sharing a `group` are OR'd together, set off from the next group by a divider. */
+    group?: string;
+    options?: SearchFilterOption[];
+};
+export type SearchGroupByOption = {
+    id: string;
+    label: string;
+    active: boolean;
+    group?: string;
+    options?: SearchGroupByOption[];
+};
+export type SearchFavorite = {
+    id: string;
+    label: string;
+    isDefault: boolean;
+    active: boolean;
+};
+export type SearchFilterCustomRule = {
+    id: string;
+    field: string;
+    operator: SearchFilterOperator;
+    value: string;
+    label: string;
+};
+export type SearchFilterManager = {
+    applyFunction: string;
+    bodyId: string;
+    /** Static, screen-owned input kept with every apply request (for example the active locale). */
+    applyInput?: Record<string, unknown>;
+    saveFavoriteFunction?: string;
+    deleteFavoriteFunction?: string;
+    setDefaultFavoriteFunction?: string;
+};
+/** A shell handles this event synchronously and supplies its navigation promise. */
+export type SearchFilterNavigateDetail = {
+    id: string;
+    href: string;
+    signal: AbortSignal;
+    respondWith(result: Promise<void>): void;
+};
+export type SearchFilterLabels = {
+    searchLabel: string;
+    searchPlaceholder: string;
+    /** Accessible name for the combined mobile Filters/Group By/Favorites sheet. */
+    toggleLabel: string;
+    filters: string;
+    groupBy: string;
+    groupByApplied?: string;
+    groupByAdd?: string;
+    groupByClear?: string;
+    groupByMoveEarlier?: string;
+    groupByMoveLater?: string;
+    favorites: string;
+    /** The field-less suggestion: `${searchGenericLabel}: "query"`. */
+    searchGenericLabel: string;
+    /** The per-field suggestion: `${searchFieldPrefix} <field> ${searchFieldPreposition}: "query"`. */
+    searchFieldPrefix: string;
+    searchFieldPreposition: string;
+    customFilterField: string;
+    customFilterOperator: string;
+    customFilterValue: string;
+    customFilterAdd: string;
+    customGroupByPlaceholder: string;
+    saveSearch: string;
+    favoriteName: string;
+    favoriteDefault: string;
+    favoriteSaveAction: string;
+    favoriteCancel?: string;
+    favoriteError?: string;
+    favoriteRemove: string;
+    favoriteSetDefault: string;
+    noFavorites: string;
+    clear: string;
+    applyError: string;
+    retry: string;
+    clearFilters?: string;
+    close?: string;
+    valueFrom?: string;
+    valueTo?: string;
+    operatorLabels?: Partial<Record<SearchFilterOperator, string>>;
+};
+export type SearchFilterConfig = {
+    name: string;
+    /** Disable unsupported editors while retaining the same search and preset-facet interaction. */
+    capabilities?: {
+        groupBy?: boolean;
+        favorites?: boolean;
+        customFilters?: boolean;
+    };
+    /** Keeps the standard interaction while reducing the search bar's visual density. */
+    size?: SearchFilterSize;
+    query?: string;
+    /** Native link to a screen-owned favorite form, when one exists. */
+    favoriteHref?: string;
+    facets: SearchFacet[];
+    filters: SearchFilterOption[];
+    groupBy: SearchGroupByOption[];
+    /** Maximum simultaneous grouping levels supported by the consumer. */
+    maxGroupBy?: number;
+    favorites: SearchFavorite[];
+    customFilterFields: CustomFilterField[];
+    /** Rules already encoded in the server-rendered list state. */
+    customFilters?: SearchFilterCustomRule[];
+    labels: SearchFilterLabels;
+    manager?: SearchFilterManager;
+};
+/** Shared by SSR and interactive chips; values remain data and choices supply display labels. */
+export declare const searchFilterRuleLabel: (options: {
+    fieldLabel: string;
+    operator: SearchFilterOperator;
+    value?: unknown;
+    choices?: CustomFilterField['choices'];
+    operatorLabels?: SearchFilterLabels['operatorLabels'];
+}) => string;
+type SearchFilterIslandProps = IslandProps & {
+    id: string;
+    config: SearchFilterConfig;
+};
+export declare function createSearchFilterView(props: SearchFilterIslandProps): IslandController;
+export declare const searchFilter: (props: IslandProps) => IslandController;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/interactions/search-filter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/design-system/src/interactions/search-filter/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAiB,WAAW,EAAkB,MAAM,wBAAwB,CAAA;AAE1G,eAAO,MAAM,KAAK,YAChB,eAAe,EACf,mBAAmB,EACnB,8BAA8B,EAC9B,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,EAC5B,qBAAqB,EACrB,wBAAwB,EACxB,6BAA6B,EAC7B,6BAA6B,EAC7B,6BAA6B,EAC7B,8BAA8B,EAC9B,8BAA8B,EAC9B,gCAAgC,EAChC,+BAA+B,EAC/B,8BAA8B,EAC9B,kCAAkC,EAClC,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,sBAAsB,EACtB,eAAe,EACf,sBAAsB,EACtB,mBAAmB,CACX,CAAA;AAEV;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,WAAW,GACX,MAAM,GACN,UAAU,CAAA;AACd,MAAM,MAAM,oBAAoB,GAC5B,UAAU,GACV,aAAa,GACb,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,SAAS,GACT,OAAO,GACP,QAAQ,GACR,SAAS,GACT,OAAO,GACP,UAAU,CAAA;AAEd,oFAAoF;AACpF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,SAAS,CAAA;AAkCpD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,qBAAqB,CAAA;IAC3B,4EAA4E;IAC5E,OAAO,CAAC,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CACtD,CAAA;AAgBD,iFAAiF;AACjF,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1G,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IACf,6FAA6F;IAC7F,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAA;AAC/F,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,gGAAgG;IAChG,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,0BAA0B,CAAC,EAAE,MAAM,CAAA;CACpC,CAAA;AAED,oFAAoF;AACpF,MAAM,MAAM,0BAA0B,GAAG;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,WAAW,CAAA;IACnB,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,iBAAiB,EAAE,MAAM,CAAA;IACzB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,mEAAmE;IACnE,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mGAAmG;IACnG,iBAAiB,EAAE,MAAM,CAAA;IACzB,sBAAsB,EAAE,MAAM,CAAA;IAC9B,iBAAiB,EAAE,MAAM,CAAA;IACzB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,iBAAiB,EAAE,MAAM,CAAA;IACzB,eAAe,EAAE,MAAM,CAAA;IACvB,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAA;CAC/D,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,gGAAgG;IAChG,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IAClF,qFAAqF;IACrF,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,OAAO,EAAE,kBAAkB,EAAE,CAAA;IAC7B,OAAO,EAAE,mBAAmB,EAAE,CAAA;IAC9B,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,cAAc,EAAE,CAAA;IAC3B,kBAAkB,EAAE,iBAAiB,EAAE,CAAA;IACvC,+DAA+D;IAC/D,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACxC,MAAM,EAAE,kBAAkB,CAAA;IAC1B,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B,CAAA;AAED,iGAAiG;AACjG,eAAO,MAAM,qBAAqB,YAAa;IAC7C,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAA;IACtC,cAAc,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAA;CACtD,KAAG,MAeH,CAAA;AAED,KAAK,uBAAuB,GAAG,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,CAAA;AAiDvF,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,uBAAuB,GAAG,gBAAgB,CAktCvF;AAED,eAAO,MAAM,YAAY,UAAW,WAAW,KAAG,gBACQ,CAAA"}