@imtf/dms-core 1.0.0-beta.1

package/core/providers/Definitions/types.d.ts

@@ -0,0 +1,248 @@
+import { FORM_DEFINITION, HUMAN_TASK_DEFINITION, MDM_EDITOR_DEFINITION } from "../../../core/constants/kinds";
+import type { Component } from "../Search/types";
+type Codetype = {
+    active: boolean;
+    id: string;
+    value: string;
+};
+export type Codetypes = Codetype[];
+type FormRule = {
+    conditions: Record<string, unknown>;
+    event: {
+        type: string;
+        params: Record<string, unknown>;
+    };
+};
+export type FormDefinition = {
+    kind: typeof FORM_DEFINITION;
+    name: string;
+    uiSchema: Record<string, any>;
+    jsonSchema: Record<string, any>;
+    rules: FormRule[];
+};
+export type MdmEditorRelation = {
+    relationName: string;
+    direction: "IN" | "OUT";
+};
+type MdmFieldColumn = {
+    property: string;
+    label: string;
+    formatter?: string;
+};
+/**
+ * Currently all
+ */
+export type MdmEditorDefinition = {
+    kind: typeof MDM_EDITOR_DEFINITION;
+    name: string;
+    attached: MdmEditorRelation[];
+    "auto-attach-behaviour": MdmEditorRelation | null;
+    /**
+     * @deprecated
+     */
+    directlyCreateEntitiesOnBackend: boolean;
+    documentTypes: Array<{
+        type: string;
+        title: string;
+        required: boolean;
+    }>;
+    entityType: string;
+    formName: string;
+    minItems: number;
+    maxItems: number;
+    nestedMdmEditors: Array<{
+        label: string;
+        name: string;
+    }>;
+    related: unknown[];
+    triggerQuestionnaireReload: boolean;
+    triggerTaskDataReload: boolean;
+    searchContext?: string;
+    enforceSearchBeforeCreate?: boolean;
+    ui_autosave: boolean;
+    ui_display: {
+        type: "formCard" | "tableCard" | "modalCard" | "listCard";
+        addButtonLabel?: string;
+        title?: string;
+        create?: boolean;
+        search?: boolean;
+        activeTab?: "search" | "create";
+        columns?: MdmFieldColumn[];
+        searchColumns?: MdmFieldColumn[];
+        listmaker?: Record<string, unknown>;
+        orderedBy?: string;
+        hideTitle?: boolean;
+    };
+    ui_label: string;
+    ui_subtitle: string;
+    ui_pageSize: number;
+    ui_readonly: boolean;
+    "ui_relation-panel-forms": Array<{
+        relationName: string;
+        formName?: string;
+        columns?: MdmFieldColumn[];
+    }>;
+    ui_repeatable: boolean | null;
+};
+export type CaseDefinition = {
+    kind: "acm.CaseDefinition";
+    capabilities: {
+        kind: "dms-acl.CaseDefinitionCapabilities";
+        canCreateCase: boolean;
+    };
+    name: string;
+    label: string;
+    parameters: Record<string, unknown>;
+    commentRequired: boolean;
+    formName: string;
+    payloadEditors: unknown[] | null;
+    masterToScopeEntityListResource: unknown;
+};
+export type CasePayloadEditorDefinition = {
+    kind: "acm.CasePayloadEditorDefinition";
+    name: string;
+    label: string;
+    formName: string;
+};
+export type TaskOutcome = {
+    kind: "acm.HumanTaskOutcomeDefinition";
+    label: string;
+    outcome: string | null;
+    requiresComment: boolean;
+    validateForm: boolean;
+};
+export type TaskDefinition = {
+    adhocTask: boolean;
+    kind: typeof HUMAN_TASK_DEFINITION;
+    name: string;
+    label: string;
+    type: "form" | "todo" | "documents" | "documents_filing" | "documents_approval";
+    assignRequiresComment: boolean;
+    canProcessTaskFromActionMenu: boolean;
+    commentRequired: boolean;
+    ownerRequired: boolean;
+    delegateRequiresComment: boolean;
+    form?: {
+        kind: "acm.HumanTaskFormDefinition";
+        name: string;
+        type: "questionnaire" | "mdmEditor" | "aml_qualification" | "contextEntityEditor" | "documentUpload" | "displayText" | "plugin" | "adverseMedia" | "riskAssessment";
+    };
+    outcomes: {
+        kind: "acm.HumansTaskOutcomeDefinitionList";
+        items: Array<TaskOutcome>;
+    };
+    uiOptions?: {
+        kind: "acm.HumanTaskUiOptionsDefinition";
+        icon?: string;
+    };
+    humanTaskCreationForm?: string;
+    permissions: {
+        CREATE_AD_HOC_TASK: boolean;
+        READ: boolean;
+    };
+};
+export type SidePanelInspectorDefinition = {
+    name: string;
+    key: string;
+    payload?: {
+        title?: string;
+        fullHeight?: boolean;
+        config?: {
+            [key: string]: any;
+        };
+        [key: string]: any;
+    };
+    isExpanded?: boolean;
+};
+export type SidePanelDataInspectorDefinition = {
+    payload: {
+        config: Record<string, any>;
+        entitiesSelector?: {
+            entityTypes: string[];
+            attachedEntities?: string[];
+            orderBy?: string;
+        };
+        limit?: number;
+    };
+} & SidePanelInspectorDefinition;
+export type SidePanelDefinition = {
+    kind: "SidePanelResourceList";
+    name: "side-panel";
+    panels: Array<{
+        kind: "SidePanelResource";
+        contentType: "UI-SidePanel";
+        label: string;
+        name: string;
+        resourceNames: string[];
+        position: "right" | "left";
+        resourceKind: "acm.Case" | "acm.HumanTask" | "dms-core.Folder" | "dms-core.File" | "dms-core.Dossier" | "mdm.Entity";
+        tabs: Array<{
+            label: string;
+            name: string;
+            inspectors: SidePanelInspectorDefinition[];
+        }>;
+    }>;
+};
+export type InspectorsDefinition = Record<SidePanelDefinition["panels"][0]["resourceKind"], Record<string, {
+    tabs: SidePanelDefinition["panels"][0]["tabs"];
+}>>;
+export type FilterOption = {
+    label: string;
+    name: string;
+};
+type StateFilter = {
+    stateMachineName: string;
+    states: FilterOption[];
+};
+export type DocumentUploadDefinition<T = {
+    type: string;
+    required: boolean;
+}> = {
+    kind: "acm.DocumentUploadDefinition";
+    name: string;
+    mdmEntitiesDocuments: Array<{
+        mdmEntityType: string;
+        documentTypes: Array<T>;
+    }>;
+    stateFilter?: StateFilter;
+};
+export type Module = "fm_search" | "tasks" | "cases" | "c360";
+export type SearchContextDefinition = {
+    enabledInFulltextSearchBar: boolean;
+    force: boolean;
+    hitList: string;
+    kind: "dms-core.ui.SearchContext";
+    label: string;
+    name: string;
+    searchMask: SearchMask["name"];
+    formName?: string;
+    modules: Module[] | null;
+    isSingleton?: boolean;
+};
+export type SearchMask = {
+    kind: "dms-core.ui.SearchMask";
+    defaultQuery: string;
+    defaultOrdering: string;
+    defaultHighlight?: {
+        kind: "dms-core.ui.component.HighlightFieldResource";
+        snippets: number;
+        field: string;
+    };
+    initialSearchEnabled: boolean;
+    label: string;
+    name: string;
+    components: Component[];
+    searchMode: "filter" | "search";
+};
+export type MdmRelationshipDefinitionList = {
+    kind: "mdm.RelationshipDefinitionList";
+    items: Array<{
+        kind: "mdm.RelationshipDefinition";
+        direction: "IN" | "OUT";
+        startEntityName: string;
+        endEntityName: string;
+        type: string;
+        "ui:label": string;
+    }>;
+};
+export {};