@g1cloud/bluesea 5.0.0-beta.2 → 5.0.0-beta.20

package/dist/component/tree/BSTreeRow.vue.d.ts

@@ -8,14 +8,15 @@ declare const _default: <T>(__VLS_props: {
     childrenProvider: TreeChildrenProvider<T>;
     labelProvider?: LabelProvider<T> | undefined;
     enableDragAndDrop?: boolean | DragAndDropPolicy | undefined;
-    showCheckbox?: boolean | undefined;
+    siblings: T[];
     iconProvider?: IconProvider<T> | undefined;
+    showCheckbox?: boolean | undefined;
     readonly onToggleRow?: ((row: T, expanded: boolean) => any) | undefined;
     readonly onSelectRow?: ((event: TreeRowSelectEvent<T>) => any) | undefined;
     readonly onMoveRow?: ((row: T, siblings: T[], destRow: T | undefined, destSiblings: T[] | undefined, destIndex: number) => any) | undefined;
     parentRow: T | undefined;
-    siblings: T[];
     disabledProvider?: ((item: T) => boolean) | undefined;
+    displayProvider?: ((item: T) => boolean) | undefined;
     multiSelect?: boolean | undefined;
     showMoveButton?: boolean | undefined;
 } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, __VLS_ctx?: {
@@ -33,14 +34,15 @@ declare const _default: <T>(__VLS_props: {
         childrenProvider: TreeChildrenProvider<T>;
         labelProvider?: LabelProvider<T> | undefined;
         enableDragAndDrop?: boolean | DragAndDropPolicy | undefined;
-        showCheckbox?: boolean | undefined;
+        siblings: T[];
         iconProvider?: IconProvider<T> | undefined;
+        showCheckbox?: boolean | undefined;
         readonly onToggleRow?: ((row: T, expanded: boolean) => any) | undefined;
         readonly onSelectRow?: ((event: TreeRowSelectEvent<T>) => any) | undefined;
         readonly onMoveRow?: ((row: T, siblings: T[], destRow: T | undefined, destSiblings: T[] | undefined, destIndex: number) => any) | undefined;
         parentRow: T | undefined;
-        siblings: T[];
         disabledProvider?: ((item: T) => boolean) | undefined;
+        displayProvider?: ((item: T) => boolean) | undefined;
         multiSelect?: boolean | undefined;
         showMoveButton?: boolean | undefined;
     } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps;
@@ -62,14 +64,15 @@ declare const _default: <T>(__VLS_props: {
             childrenProvider: TreeChildrenProvider<T>;
             labelProvider?: LabelProvider<T> | undefined;
             enableDragAndDrop?: boolean | DragAndDropPolicy | undefined;
-            showCheckbox?: boolean | undefined;
+            siblings: T[];
             iconProvider?: IconProvider<T> | undefined;
+            showCheckbox?: boolean | undefined;
             readonly onToggleRow?: ((row: T, expanded: boolean) => any) | undefined;
             readonly onSelectRow?: ((event: TreeRowSelectEvent<T>) => any) | undefined;
             readonly onMoveRow?: ((row: T, siblings: T[], destRow: T | undefined, destSiblings: T[] | undefined, destIndex: number) => any) | undefined;
             parentRow: T | undefined;
-            siblings: T[];
             disabledProvider?: ((item: T) => boolean) | undefined;
+            displayProvider?: ((item: T) => boolean) | undefined;
             multiSelect?: boolean | undefined;
             showMoveButton?: boolean | undefined;
         } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps;

package/dist/component/tree/TreeLib.d.ts

@@ -1,7 +1,11 @@
+import { KeyProvider } from '../../model/CommonTypes.ts';
+import { TreeChildrenProvider } from './TreeModel.ts';
+
 export declare const defaultTreeChildrenProvider: <T>(item: T) => (T[] | undefined);
 export declare class TreeRowStatuses<T> {
     expanded: Set<string>;
     selected: Set<T>;
+    focused?: T;
 }
 export type TreeRowSelectEvent<T> = {
     row: T;
@@ -9,3 +13,19 @@ export type TreeRowSelectEvent<T> = {
     multiSelect: boolean;
     veto?: boolean;
 };
+export declare class TreeKeyboardHandler<T> {
+    private dataProvider;
+    private treeRowStatuses;
+    private keyProvider;
+    private childrenProvider;
+    private isMultiSelect;
+    private selectRow;
+    constructor(dataProvider: () => T[], treeRowStatuses: TreeRowStatuses<T>, keyProvider: KeyProvider<T>, childrenProvider: TreeChildrenProvider<T>, isMultiSelect: () => boolean, selectRow: (event: TreeRowSelectEvent<T>) => void);
+    handleKeyDown(event: KeyboardEvent): void;
+    moveFocused(item: T): void;
+    clearFocus(): void;
+    private getCurrentItem;
+    private findTreeItemContext;
+    private findNextSiblingOfParent;
+    private findExpandedLastDescendant;
+}

package/dist/component/tree/TreeModel.d.ts

@@ -35,9 +35,28 @@ export interface TreeHandler<T> {
     treeEventListener: TreeEventListener<T>;
     control: UnwrapNestedRefs<TreeControlBinding<T>>;
     controlEventListener: TreeControlEventListener;
+    /**
+     * Tree 에 data 를 넣는다.
+     * @param data
+     * @param keepSelection true 이면 현재 선택된 항목이 유지된다.
+     * @param keepExpanded  true 이면 현재 expanded 인 항목이 유지된다.
+     * @param waitTime      이 값이 0보다 크면 이 시간동안 tree 를 비웠다가 다시 채운다. refresh 효과를 위해 사용한다. millisecond 단위.
+     */
     setTreeData(data: T[], keepSelection?: boolean, keepExpanded?: boolean, waitTime?: number): Promise<void>;
+    /**
+     * 항목을 선택한다.
+     * @param item
+     */
     selectItem(item: T | T[] | undefined): void;
+    /**
+     * `item` 의 parent 를 리턴한다.
+     * @param item
+     */
     getParent(item: T | undefined): T | undefined;
+    /**
+     * `item` 을 교체한다. item 이 변경된 경우, 변경된 객체를 tree 에 다시 표시할 때 사용한다.
+     * @param newItem
+     */
     replaceCurrentItem(newItem: T): void;
     /**
      * Tree 이 모든 항목을 순회하며 visitor 함수를 호출한다. visitor 함수가
@@ -63,7 +82,16 @@ export interface TreeHandler<T> {
      * @param index 추가할 위치. 0 보다 작으면 제일 마지막에 추가한다. 디폴트는 -1.
      */
     addChildItem(parent: T, index: number): void;
+    /**
+     * `items` 를 삭제한다.
+     * @param items
+     */
     removeItems(items: T[]): void;
+    /**
+     * Tree 전체를 펼치거나 접는다.
+     * @param expandOrDepth true 이면 전체를 펼치고, false 이면 접는다. 숫자이면 해당 depth 까지 표시되도록 펼친다.
+     */
+    expandAll(expandOrDepth: boolean | number): void;
 }
 export type TreeBinding<T> = {
     data: T[];
@@ -120,7 +148,7 @@ export type TreeHandlerOption<T> = {
      */
     canChangeSelection?: (prev: T | undefined, next: T | undefined) => boolean;
     /**
-     * 현재 선택된 항목으 변경되었는지 여부를 리턴한다.
+     * 현재 선택된 항목이 변경되었는지 여부를 리턴한다.
      */
     currentItemModified?: () => boolean;
     /**
@@ -141,6 +169,10 @@ export type TreeHandlerOption<T> = {
      * TreeHandler 에서 신규 항목 추가가 필요할 때 호출된다.
      * 이 함수가 리턴한 신규 항목이 Tree 에 추가된다.
      * undefined 를 리턴하면 항목이 추가되지 않는다.
+     *
+     * 새로 생성된 항목의 parent 를 설정하는 것과 parent 에 이 항목을 추가하는 등의 작업이
+     * 이 함수 안에서 모두 이루어져야 한다. TreeHandler 가 이 작업을 대신해주지 않는다.
+     *
      * @param parent 생성할 항목의 부모. 최상위 항목이면 undefined 이다.
      * @param index 생성 위치.
      */

package/dist/config/config.d.ts

@@ -1,6 +1,6 @@
-import { Address, AddressCountry, CurrencyCode, DateResolution, DisplayDateResolution, LocaleName, MultiLangText, Tel, TelCountry, TimeZone } from '../model/CommonTypes';
+import { Address, AddressCountry, CurrencyCode, DateResolution, DisplayDateResolution, LocaleName, Money, MultiLangText, Tel, TelCountry, TimeZone } from '../model/CommonTypes';
 import { Component } from 'vue';
-import { GridPreferenceStore } from '../component/grid/GridModel.ts';
+import { Column, GridPreferenceStore } from '../component/grid/GridModel.ts';
 import { DateRangePreset } from '../component/input/DateRangePresetModel.ts';
 import { ToolButton } from '../component/richtext/RichTextModel.ts';
 
@@ -48,6 +48,9 @@ export type AddressCountryConfig = {
 export declare const ADDRESS_COUNTRY_CONFIGS: Record<string, AddressCountryConfig>;
 export declare const ADDRESS_COUNTRY_CONFIG_DEFAULT: AddressCountryConfig;
 export declare const defaultAddressInputComponentConfig: AddressInputComponentConfig;
+export type GridComponentConfig = {
+    defaultCellFormatter?: <T>(column: Column, value: T) => string | T | null | undefined;
+};
 export type GridLookupComponentConfig = {
     dateRangePresets?: DateRangePreset[];
     dateFilterDateFormat?: string;
@@ -78,6 +81,7 @@ export type ComponentConfig = {
     telInput?: TelInputComponentConfig;
     nameInput?: NameInputComponentConfig;
     addressInput?: AddressInputComponentConfig;
+    grid?: GridComponentConfig;
     gridLookup?: GridLookupComponentConfig;
     richText?: RichTextComponentConfig;
     upload?: UploadComponentConfig;
@@ -88,12 +92,14 @@ export type TimeZoneNameProvider = (tzId: string) => string;
 export type FileUrlResolver = (fileUrl?: string) => string | undefined;
 export type TelSerializer = (tel?: Tel, showCountryNo?: boolean) => string;
 export type AddressSerializer = (address?: Address) => string;
+export type MoneySerializer = (value?: Money) => string;
 declare class BlueseaConfig {
     locales: LocaleName[];
     defaultLocale: LocaleName;
     currentLocale: LocaleName;
     dataLocales: LocaleName[];
     currentDataLocale: LocaleName;
+    defaultDataLocale: LocaleName;
     timeZone: TimeZone;
     displayTimeZones: TimeZone[];
     allTimeZones: TimeZone[];
@@ -113,11 +119,12 @@ declare class BlueseaConfig {
     componentConfig: ComponentConfig;
     telSerializer?: TelSerializer;
     addressSerializer?: AddressSerializer;
+    moneySerializer?: MoneySerializer;
     constructor();
     configure(options: BlueseaConfigRaw): void;
     setLocales(locales: LocaleName[], defaultLocale: LocaleName, currentLocale: LocaleName): void;
     setCurrentLocale(locale?: LocaleName): void;
-    setDataLocales(dataLocales: LocaleName[], currentDataLocale: LocaleName): void;
+    setDataLocales(dataLocales: LocaleName[], currentDataLocale: LocaleName, defaultDataLocale?: LocaleName): void;
     setCurrentDataLocale(locale?: LocaleName): void;
     getValidDisplayTimeZones(): TimeZone[];
     resolveDisplayDateFormat(format?: string | DisplayDateResolution): string;
@@ -127,8 +134,8 @@ export type BlueseaConfigRaw = {
     defaultLocale?: LocaleName;
     currentLocale?: LocaleName;
     dataLocales?: LocaleName[];
-    defaultDataLocale?: LocaleName;
     currentDataLocale?: LocaleName;
+    defaultDataLocale?: LocaleName;
     timeZone?: TimeZone;
     displayTimeZones?: TimeZone[];
     allTimeZones?: TimeZone[];
@@ -146,8 +153,9 @@ export type BlueseaConfigRaw = {
     blankImageUrl?: string;
     gridPreferenceStore?: GridPreferenceStore;
     componentConfig?: ComponentConfig;
-    telSerializer?: (tel?: Tel) => string;
-    addressSerializer?: (address?: Address) => string;
+    telSerializer?: TelSerializer;
+    addressSerializer?: AddressSerializer;
+    moneySerializer?: MoneySerializer;
 };
 export declare const blueseaConfig: BlueseaConfig;
 export declare const configureBluesea: (options: BlueseaConfigRaw) => void;

package/dist/directive/vT.d.ts

@@ -5,6 +5,12 @@ import { MultiLangText } from '../model/CommonTypes';
  * MultiLangText 를 해석해 표시할 string 을 만든다.
  * currentDataLocale 을 사용하는 경우, currentDataLocale 이 변경되어도 텍스트가 변경되지 않는다.
  */
+export declare const t: (text?: MultiLangText, locale?: string) => string;
+/**
+ * MultiLangText 를 해석해 표시할 string 을 만든다.
+ * currentDataLocale 을 사용하는 경우, currentDataLocale 이 변경되어도 텍스트가 변경되지 않는다.
+ * @deprecated use t() function instead.
+ */
 export declare const interpretMultiLangText: (text?: MultiLangText, locale?: string) => string;
 declare const vT: ObjectDirective;
 export default vT;

package/dist/frame/default/DefaultFrameModel.d.ts

@@ -2,6 +2,7 @@ import { RawData } from '../../util/typeUtil';
 import { RouteLocation, Router } from 'vue-router';
 import { FavoriteMenuHandler, FrameContext, Menu, MenuCaptionProvider, Page, PageInstance, PageTitleProvider, PageTitleRenderer } from '../FrameModel';
 import { ShortcutKeyHandler } from '../ShortcutKeyHandler.ts';
+import { MultiLangText } from '../../model/CommonTypes.ts';
 
 export type DefaultFrameConfig = {
     router: Router;
@@ -29,6 +30,7 @@ export declare class DefaultFrameContext implements FrameContext {
     syncCurrentPath(route: RouteLocation): Promise<void>;
     closeActivePage(): Promise<void>;
     getPageByRoute(route: RouteLocation): PageInstance | undefined;
+    setPageTitle(route: RouteLocation, title?: MultiLangText): void;
     setPageSubtitle(route: RouteLocation, subtitle?: string): void;
     /**
      * pagePath 에 해당하는 화면 URL 로 이동한다.