@cornerstonejs/metadata 5.13.1 → 5.14.0

package/dist/esm/displayset/displaySetRulesTypes.d.ts

@@ -0,0 +1,34 @@
+import type { NaturalizedInstance, RuleContext, SeriesFunction, SeriesFunctionDefinition, SplitRule } from './types.js';
+import type { RawCondition, RawMatchTest } from '../safeFunctions/index.js';
+import type { ContextEntry, ContextValues, DisplaySetContext } from './displaySetContext.js';
+export type { ContextEntry, ContextValues, DisplaySetContext, RawCondition, RawMatchTest, };
+export type RawName = string;
+export type InstanceHook = (instance: NaturalizedInstance, context: RuleContext) => unknown;
+export type RawSortKey = RawName | {
+    sortFunction: string;
+} | NonNullable<SplitRule['compareInstances']>;
+export type RawAttributeValue = RawName | number | boolean | null | {
+    template: string;
+} | {
+    expression: string;
+} | ((instances: NaturalizedInstance[], values: ContextValues) => unknown);
+export type RawSplitRule = {
+    id?: string;
+    groupId?: string;
+    priority: number | null;
+    description?: string;
+    handler?: string;
+    viewportTypes?: string[];
+    context?: DisplaySetContext;
+    matches?: RawCondition;
+    groupBy?: (RawName | InstanceHook)[];
+    sortBy?: RawSortKey[];
+    attributes?: Record<string, RawAttributeValue> | NonNullable<SplitRule['customAttributes']>;
+};
+export type DisplaySetRules = Record<string, RawSplitRule>;
+export type CreateDisplaySetSplitRulesOptions = {
+    context?: Record<string, ContextEntry>;
+    seriesFunctions?: Record<string, SeriesFunction | SeriesFunctionDefinition>;
+    deniedNames?: readonly string[];
+    sortFunctions?: Record<string, NonNullable<SplitRule['compareInstances']>>;
+};