@platforma-sdk/model 1.40.1 → 1.40.6

package/dist/components/PlAnnotations/filters_ui.d.ts

@@ -0,0 +1,823 @@
+import { SUniversalPColumnId } from '@milaboratories/pl-model-common';
+import { AnnotationFilter, AnnotationMode, AnnotationScript, PatternPredicate } from './filter';
+import { SimplifiedPColumnSpec } from './types';
+export declare function unreachable(x: never): never;
+declare function isNumericValueType(spec: SimplifiedPColumnSpec): boolean;
+declare function isStringValueType(spec: SimplifiedPColumnSpec): boolean;
+export type FilterUi = {
+    id?: number;
+    name?: string;
+    isExpanded?: boolean;
+} & ({
+    type: undefined;
+} | {
+    type: 'or';
+    filters: FilterUi[];
+} | {
+    type: 'and';
+    filters: FilterUi[];
+} | {
+    type: 'not';
+    filter: FilterUi;
+} | {
+    type: 'isNA';
+    column: SUniversalPColumnId;
+} | {
+    type: 'isNotNA';
+    column: SUniversalPColumnId;
+} | {
+    type: 'patternEquals';
+    column: SUniversalPColumnId;
+    value: string;
+} | {
+    type: 'patternNotEquals';
+    column: SUniversalPColumnId;
+    value: string;
+} | {
+    type: 'patternContainSubsequence';
+    column: SUniversalPColumnId;
+    value: string;
+} | {
+    type: 'patternNotContainSubsequence';
+    column: SUniversalPColumnId;
+    value: string;
+} | {
+    type: 'topN';
+    column: SUniversalPColumnId;
+    n: number;
+} | {
+    type: 'bottomN';
+    column: SUniversalPColumnId;
+    n: number;
+} | {
+    type: 'lessThan';
+    column: SUniversalPColumnId;
+    x: number;
+} | {
+    type: 'greaterThan';
+    column: SUniversalPColumnId;
+    x: number;
+} | {
+    type: 'lessThanOrEqual';
+    column: SUniversalPColumnId;
+    x: number;
+} | {
+    type: 'greaterThanOrEqual';
+    column: SUniversalPColumnId;
+    x: number;
+} | {
+    type: 'lessThanColumn';
+    column: SUniversalPColumnId;
+    rhs: SUniversalPColumnId;
+    minDiff?: number;
+} | {
+    type: 'lessThanColumnOrEqual';
+    column: SUniversalPColumnId;
+    rhs: SUniversalPColumnId;
+    minDiff?: number;
+});
+export type FilterUiType = Exclude<FilterUi, {
+    type: undefined;
+}>['type'];
+export type FilterUiOfType<T extends FilterUiType> = Extract<FilterUi, {
+    type: T;
+}>;
+export type TypeToLiteral<T> = [
+    T
+] extends [FilterUiType] ? 'FilterUiType' : [
+    T
+] extends [SUniversalPColumnId] ? 'SUniversalPColumnId' : [
+    T
+] extends [PatternPredicate] ? 'PatternPredicate' : [
+    T
+] extends [AnnotationFilter[]] ? 'AnnotationFilter[]' : [
+    T
+] extends [AnnotationFilter] ? 'AnnotationFilter' : [
+    T
+] extends [number] ? 'number' : [
+    T
+] extends [number | undefined] ? 'number?' : [
+    T
+] extends [string] ? 'string' : [
+    T
+] extends [string | undefined] ? 'string?' : [
+    T
+] extends [boolean] ? 'boolean' : [
+    T
+] extends [boolean | undefined] ? 'boolean?' : [
+    T
+] extends [unknown[]] ? 'unknown[]' : T extends number ? 'number' : T extends string ? 'string' : T extends boolean ? 'boolean' : T extends Record<string, unknown> ? 'form' : 'unknown';
+export type TypeField<V> = {
+    fieldType: TypeToLiteral<V>;
+    label: string;
+    defaultValue: () => V | undefined;
+};
+export type TypeFieldRecord<T> = {
+    [K in keyof T]: TypeField<T[K]>;
+};
+export type TypeForm<T> = {
+    [P in keyof T]: T[P] extends Record<string, unknown> ? {
+        fieldType: 'form';
+        label?: string;
+        form?: T[P] extends Record<string, unknown> ? TypeForm<T[P]> : undefined;
+        defaultValue: () => T[P];
+    } : TypeField<T[P]>;
+};
+export type FormField = {
+    fieldType: 'form';
+    form?: Record<string, FormField>;
+    defaultValue: () => Record<string, unknown>;
+} | TypeField<FilterUiType> | TypeField<string> | TypeField<number> | TypeField<number | undefined> | TypeField<boolean> | TypeField<boolean | undefined> | TypeField<SUniversalPColumnId>;
+export type AnyForm = Record<string, FormField>;
+export declare const filterUiMetadata: {
+    lessThan: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "lessThan";
+            };
+            x: {
+                label: string;
+                fieldType: "number";
+                defaultValue: () => number;
+            };
+        };
+        supportedFor: typeof isNumericValueType;
+    };
+    greaterThan: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "greaterThan";
+            };
+            x: {
+                label: string;
+                fieldType: "number";
+                defaultValue: () => number;
+            };
+        };
+        supportedFor: typeof isNumericValueType;
+    };
+    lessThanOrEqual: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "lessThanOrEqual";
+            };
+            x: {
+                label: string;
+                fieldType: "number";
+                defaultValue: () => number;
+            };
+        };
+        supportedFor: typeof isNumericValueType;
+    };
+    greaterThanOrEqual: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "greaterThanOrEqual";
+            };
+            x: {
+                label: string;
+                fieldType: "number";
+                defaultValue: () => number;
+            };
+        };
+        supportedFor: typeof isNumericValueType;
+    };
+    lessThanColumn: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "lessThanColumn";
+            };
+            rhs: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            minDiff: {
+                label: string;
+                fieldType: "number?";
+                defaultValue: () => undefined;
+            };
+        };
+        supportedFor: (spec1: SimplifiedPColumnSpec, spec2?: SimplifiedPColumnSpec) => boolean;
+    };
+    lessThanColumnOrEqual: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "lessThanColumnOrEqual";
+            };
+            rhs: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            minDiff: {
+                label: string;
+                fieldType: "number?";
+                defaultValue: () => undefined;
+            };
+        };
+        supportedFor: (spec1: SimplifiedPColumnSpec, spec2?: SimplifiedPColumnSpec) => boolean;
+    };
+    topN: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "topN";
+            };
+            n: {
+                label: string;
+                fieldType: "number";
+                defaultValue: () => number;
+            };
+        };
+        supportedFor: typeof isNumericValueType;
+    };
+    bottomN: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "bottomN";
+            };
+            n: {
+                label: string;
+                fieldType: "number";
+                defaultValue: () => number;
+            };
+        };
+        supportedFor: typeof isNumericValueType;
+    };
+    patternContainSubsequence: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "patternContainSubsequence";
+            };
+            value: {
+                label: string;
+                fieldType: "string";
+                defaultValue: () => string;
+            };
+        };
+        supportedFor: typeof isStringValueType;
+    };
+    patternNotContainSubsequence: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "patternNotContainSubsequence";
+            };
+            value: {
+                label: string;
+                fieldType: "string";
+                defaultValue: () => string;
+            };
+        };
+        supportedFor: typeof isStringValueType;
+    };
+    patternEquals: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "patternEquals";
+            };
+            value: {
+                label: string;
+                fieldType: "string";
+                defaultValue: () => string;
+            };
+        };
+        supportedFor: typeof isStringValueType;
+    };
+    patternNotEquals: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "patternNotEquals";
+            };
+            value: {
+                label: string;
+                fieldType: "string";
+                defaultValue: () => string;
+            };
+        };
+        supportedFor: typeof isStringValueType;
+    };
+    isNA: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "isNA";
+            };
+        };
+        supportedFor: () => true;
+    };
+    isNotNA: {
+        label: string;
+        form: {
+            column: {
+                label: string;
+                fieldType: "SUniversalPColumnId";
+                defaultValue: () => undefined;
+            };
+            type: {
+                label: string;
+                fieldType: "FilterUiType";
+                defaultValue: () => "isNotNA";
+            };
+        };
+        supportedFor: () => true;
+    };
+    or: {
+        label: string;
+        form: {
+            type: {
+                fieldType: "FilterUiType";
+                label: string;
+                defaultValue: () => "or";
+            };
+            filters: {
+                fieldType: "unknown[]";
+                label: string;
+                defaultValue: () => never[];
+            };
+        };
+        supportedFor: () => false;
+    };
+    and: {
+        label: string;
+        form: {
+            type: {
+                fieldType: "FilterUiType";
+                label: string;
+                defaultValue: () => "and";
+            };
+            filters: {
+                fieldType: "unknown[]";
+                label: string;
+                defaultValue: () => never[];
+            };
+        };
+        supportedFor: () => false;
+    };
+    not: {
+        label: string;
+        form: {
+            type: {
+                fieldType: "FilterUiType";
+                label: string;
+                defaultValue: () => "not";
+            };
+            filter: {
+                fieldType: "form";
+                label: string;
+                defaultValue: () => FilterUi;
+            };
+        };
+        supportedFor: () => false;
+    };
+};
+export declare function getFilterUiTypeOptions(columnSpec?: SimplifiedPColumnSpec): {
+    label: string;
+    value: string;
+}[];
+export declare function getFilterUiMetadata(type: FilterUiType): {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "lessThan";
+        };
+        x: {
+            label: string;
+            fieldType: "number";
+            defaultValue: () => number;
+        };
+    };
+    supportedFor: typeof isNumericValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "greaterThan";
+        };
+        x: {
+            label: string;
+            fieldType: "number";
+            defaultValue: () => number;
+        };
+    };
+    supportedFor: typeof isNumericValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "lessThanOrEqual";
+        };
+        x: {
+            label: string;
+            fieldType: "number";
+            defaultValue: () => number;
+        };
+    };
+    supportedFor: typeof isNumericValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "greaterThanOrEqual";
+        };
+        x: {
+            label: string;
+            fieldType: "number";
+            defaultValue: () => number;
+        };
+    };
+    supportedFor: typeof isNumericValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "lessThanColumn";
+        };
+        rhs: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        minDiff: {
+            label: string;
+            fieldType: "number?";
+            defaultValue: () => undefined;
+        };
+    };
+    supportedFor: (spec1: SimplifiedPColumnSpec, spec2?: SimplifiedPColumnSpec) => boolean;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "lessThanColumnOrEqual";
+        };
+        rhs: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        minDiff: {
+            label: string;
+            fieldType: "number?";
+            defaultValue: () => undefined;
+        };
+    };
+    supportedFor: (spec1: SimplifiedPColumnSpec, spec2?: SimplifiedPColumnSpec) => boolean;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "topN";
+        };
+        n: {
+            label: string;
+            fieldType: "number";
+            defaultValue: () => number;
+        };
+    };
+    supportedFor: typeof isNumericValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "bottomN";
+        };
+        n: {
+            label: string;
+            fieldType: "number";
+            defaultValue: () => number;
+        };
+    };
+    supportedFor: typeof isNumericValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "patternContainSubsequence";
+        };
+        value: {
+            label: string;
+            fieldType: "string";
+            defaultValue: () => string;
+        };
+    };
+    supportedFor: typeof isStringValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "patternNotContainSubsequence";
+        };
+        value: {
+            label: string;
+            fieldType: "string";
+            defaultValue: () => string;
+        };
+    };
+    supportedFor: typeof isStringValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "patternEquals";
+        };
+        value: {
+            label: string;
+            fieldType: "string";
+            defaultValue: () => string;
+        };
+    };
+    supportedFor: typeof isStringValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "patternNotEquals";
+        };
+        value: {
+            label: string;
+            fieldType: "string";
+            defaultValue: () => string;
+        };
+    };
+    supportedFor: typeof isStringValueType;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "isNA";
+        };
+    };
+    supportedFor: () => true;
+} | {
+    label: string;
+    form: {
+        column: {
+            label: string;
+            fieldType: "SUniversalPColumnId";
+            defaultValue: () => undefined;
+        };
+        type: {
+            label: string;
+            fieldType: "FilterUiType";
+            defaultValue: () => "isNotNA";
+        };
+    };
+    supportedFor: () => true;
+} | {
+    label: string;
+    form: {
+        type: {
+            fieldType: "FilterUiType";
+            label: string;
+            defaultValue: () => "or";
+        };
+        filters: {
+            fieldType: "unknown[]";
+            label: string;
+            defaultValue: () => never[];
+        };
+    };
+    supportedFor: () => false;
+} | {
+    label: string;
+    form: {
+        type: {
+            fieldType: "FilterUiType";
+            label: string;
+            defaultValue: () => "and";
+        };
+        filters: {
+            fieldType: "unknown[]";
+            label: string;
+            defaultValue: () => never[];
+        };
+    };
+    supportedFor: () => false;
+} | {
+    label: string;
+    form: {
+        type: {
+            fieldType: "FilterUiType";
+            label: string;
+            defaultValue: () => "not";
+        };
+        filter: {
+            fieldType: "form";
+            label: string;
+            defaultValue: () => FilterUi;
+        };
+    };
+    supportedFor: () => false;
+};
+export declare function compileFilter(ui: FilterUi): AnnotationFilter;
+export declare function compileFilters(uiFilters: FilterUi[]): AnnotationFilter[];
+export type AnnotationStepUi = {
+    id?: number;
+    label: string;
+    filter: Extract<FilterUi, {
+        type: 'and' | 'or';
+    }>;
+};
+export type AnnotationScriptUi = {
+    isCreated?: boolean;
+    title: string;
+    mode: AnnotationMode;
+    steps: AnnotationStepUi[];
+};
+export declare function compileAnnotationScript(uiScript: AnnotationScriptUi): AnnotationScript;
+export {};
+//# sourceMappingURL=filters_ui.d.ts.map