Skip to content

Commit 1337b37

Browse files
authored
feat(utils): add DefaultUtils typing to index.d.ts (#1078)
1 parent 6028fae commit 1337b37

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

packages/core/modules/index.d.ts

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,24 @@ interface ConfigUtils {
547547
cleanJSX(jsx: any): Object;
548548
applyJsonLogic(logic: any, data?: any): any;
549549
}
550+
interface DefaultUtils {
551+
getDefaultField(config: Config, canGetFirst?: boolean, parentRuleGroupPath?: IdPath): Field;
552+
getDefaultSubField(config: Config, parentRuleGroupPath?: IdPath | null): Field;
553+
getDefaultFieldSrc(config: Config, canGetFirst?: boolean): string;
554+
getDefaultOperator(config: Config, field: Field, canGetFirst?: boolean): string;
555+
defaultOperatorOptions(config: Config, field: Field, canGetFirst?: boolean): string;
556+
emptyProperties<K, V>(): ImmutableMap<K, V>;
557+
createListFromArray<TItem>(array: TItem[]): ImmutableList<TItem>;
558+
defaultRule<K, V>(id: string, config: Config): Record<string, ImmutableMap<K, V>>;
559+
defaultRoot<K, V>(config: Config, canAddDefaultRule?: boolean): ImmutableMap<K, V>;
560+
createListWithOneElement<TItem>(el: TItem): ImmutableList<TItem>;
561+
defaultItemProperties(config: Config, item: JsonRule): ImmutableRuleProperties | ImmutableGroupProperties;
562+
defaultGroupProperties(config: Config, fieldConfig: Field | Func | null): ImmutableGroupProperties;
563+
defaultRuleProperties(config: Config, parentRuleGroupPath?: IdPath, item?: JsonRule, canUseDefaultFieldAndOp?: boolean, canGetFirst?: boolean): ImmutableRuleProperties;
564+
defaultConjunction(config: Config): string;
565+
defaultOperatorOptions(config: Config, operator: string, field: Field): string;
566+
defaultGroupConjunction(config: Config, fieldConfig: Field | Func | null): string;
567+
}
550568
interface ExportUtils {
551569
wrapWithBrackets(val: string): string;
552570
spelEscape(val: any): string;
@@ -616,6 +634,7 @@ export interface Utils extends Omit<Import, "isValidTree">, Export,
616634
Autocomplete: Autocomplete;
617635
Validation: Validation;
618636
ConfigUtils: ConfigUtils;
637+
DefaultUtils: DefaultUtils;
619638
ExportUtils: ExportUtils;
620639
ListUtils: ListUtils;
621640
TreeUtils: TreeUtils;
@@ -933,7 +952,7 @@ export type TreeMultiSelectWidget<C = Config, WP = TreeMultiSelectWidgetProps<C>
933952
export type CaseValueWidget<C = Config, WP = CaseValueWidgetProps<C>> = BaseWidget<C, WP> & CaseValueFieldSettings;
934953

935954
// tip: use generic WidgetProps here, TS can't determine correct factory
936-
export type TypedWidget<C = Config> =
955+
export type TypedWidget<C = Config> =
937956
TextWidget<C, WidgetProps<C>>
938957
| DateTimeWidget<C, WidgetProps<C>>
939958
| BooleanWidget<C, WidgetProps<C>>
@@ -945,7 +964,7 @@ export type TypedWidget<C = Config> =
945964
| TreeMultiSelectWidget<C, WidgetProps<C>>
946965
| CaseValueWidget<C, WidgetProps<C>>;
947966

948-
export type Widget<C = Config> =
967+
export type Widget<C = Config> =
949968
FieldWidget<C>
950969
| FuncWidget<C>
951970
| TypedWidget<C>

0 commit comments

Comments
 (0)