@dialob/composer-material 0.0.5 → 0.0.7

package/dist-lib/index.d.ts

@@ -1,10 +1,17 @@
+import { AlertColor } from '@mui/material';
 import { Component } from 'react';
+import { ConversionMenu } from '../items/ItemComponents';
 import { default as default_2 } from 'react';
+import { EditorState } from '..';
 import { FunctionComponent } from 'react';
+import { IdField } from '../items/ItemComponents';
+import { Indicators } from '../items/ItemComponents';
 import { ItemId } from '@atlaskit/tree';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { LabelField } from '../items/ItemComponents';
 import { LanguageEditor } from '../components/translations/LanguageEditor';
+import { OptionsMenu } from '../items/ItemComponents';
+import { StyledTable } from '../items/ItemComponents';
 import { SvgIconProps } from '@mui/material';
 import { TreeDraggableProvided } from '@atlaskit/tree/dist/types/components/TreeItem/TreeItem-types';
 import { TreeItem } from '@atlaskit/tree';
@@ -92,19 +99,20 @@ export declare const ChoiceEditor: default_2.FC;
 export declare const ChoiceItem: default_2.FC<ChoiceItemProps>;
 
 declare interface ChoiceItemProps {
-    item: TreeItem;
+    entry: ValueSetEntry;
+    index: number;
     valueSetId?: string;
-    provided: TreeDraggableProvided;
     isGlobal?: boolean;
     onRuleEdit: (entry: ValueSetEntry, rule: string) => void;
     onTextEdit: (entry: ValueSetEntry, label: LocalizedString) => void;
     onDelete: (entry: ValueSetEntry) => void;
     onUpdateId: (entry: ValueSetEntry, id: string) => void;
+    onMove?: (entry: ValueSetEntry, direction: 'up' | 'down') => void;
 }
 
 export declare const ChoiceList: default_2.FC<{
     valueSet?: ValueSet;
-    updateValueSet: (value: default_2.SetStateAction<ValueSet | undefined>) => void;
+    updateValueSet?: (value: default_2.SetStateAction<ValueSet | undefined>) => void;
     isGlobal?: boolean;
 }>;
 
@@ -114,6 +122,16 @@ declare type ComposerCallbacks = {
     onAddItem?: (state: ComposerState, item: DialobItem) => void;
 };
 
+declare type ComposerMetadata = {
+    globalValueSets?: {
+        label?: string;
+        valueSetId: string;
+    }[];
+    contextValues?: {
+        [name: string]: string;
+    };
+};
+
 declare type ComposerState = {
     _id?: string;
     _rev?: string;
@@ -137,19 +155,13 @@ declare type ComposerState = {
         valid?: boolean;
         created?: string;
         lastSaved?: string;
-        composer?: {
-            globalValueSets?: {
-                label?: string;
-                valueSetId: string;
-            }[];
-            contextValues?: {
-                [name: string]: string;
-            };
-        };
+        composer?: ComposerMetadata;
         [prop: string]: any;
     };
 };
 
+declare type ComposerStatus = 'ERROR' | 'WARNING' | 'INFO' | 'FATAL' | 'OK';
+
 declare type ComposerTag = {
     name: string;
     formName: string;
@@ -170,6 +182,8 @@ declare interface ConfigItemProps {
 
 export declare const ConfirmationDialog: default_2.FC;
 
+declare type ConfirmationDialogType = 'duplicate' | 'delete';
+
 declare type ContextVariable = {
     name: string;
     published?: boolean;
@@ -187,6 +201,8 @@ export declare const ContextVariables: default_2.FC<{
 
 declare type ContextVariableType = 'text' | 'number' | 'decimal' | 'boolean' | 'date' | 'time';
 
+export { ConversionMenu }
+
 export declare const ConvertConfirmationDialog: default_2.FC<{
     type: 'local' | 'global' | undefined;
     onClick: () => void;
@@ -299,6 +315,7 @@ declare namespace DialobTypes {
         DialobItems,
         VisibilityType,
         ComposerTag,
+        ComposerMetadata,
         ComposerState,
         INIT_STATE,
         ComposerCallbacks
@@ -328,6 +345,19 @@ declare type EditorError = {
 
 declare type ErrorSeverity = 'ERROR' | 'WARNING' | 'INFO' | 'FATAL';
 
+declare namespace ErrorUtils {
+    export {
+        getErrorSeverity,
+        getItemErrorColor,
+        useErrorColorSx,
+        useErrorColor,
+        getErrorIcon,
+        getStatusIcon,
+        getStatus
+    }
+}
+export { ErrorUtils }
+
 export declare const ExpressionVariableRow: default_2.FC<VariableProps>;
 
 export declare const ExpressionVariables: default_2.FC<{
@@ -339,6 +369,16 @@ export declare const FormOptionsDialog: default_2.FC<{
     onClose: () => void;
 }>;
 
+declare const getErrorIcon: (errors: EditorError[] | undefined, itemId: string) => default_2.ReactNode | undefined;
+
+declare const getErrorSeverity: (error: EditorError) => AlertColor;
+
+declare const getItemErrorColor: (errors: EditorError[] | undefined, itemId: string) => "info" | "warning" | "error" | "primary";
+
+declare const getStatus: (errors: EditorError[] | undefined) => ComposerStatus;
+
+declare const getStatusIcon: (errors: EditorError[] | undefined) => default_2.ReactElement;
+
 export declare const GlobalList: default_2.FC<{
     entries?: ValueSetEntry[];
 }>;
@@ -352,11 +392,15 @@ export declare const Group: default_2.FC<{
     item: DialobItem;
 } & Record<string, any>>;
 
+export { IdField }
+
 declare interface IndexedRule {
     index: number;
     validationRule: ValidationRule;
 }
 
+export { Indicators }
+
 declare const INIT_STATE: ComposerState;
 
 declare const InputProp: (props: any) => JSX_2.Element;
@@ -426,6 +470,10 @@ declare interface OptionEditor {
     editor: React.FC;
 }
 
+export { OptionsMenu }
+
+declare type OptionsTabType = 'id' | 'label' | 'description' | 'rules' | 'validations' | 'choices' | 'properties';
+
 export declare const PageTabs: default_2.FC<{
     items: DialobItems;
 }>;
@@ -495,10 +543,19 @@ declare interface SaveResult {
     errors: EditorError[];
 }
 
+declare interface SavingState {
+    item?: DialobItem;
+    valueSets?: ValueSet[];
+    composerMetadata?: ComposerMetadata;
+    variables?: (ContextVariable | Variable)[];
+}
+
 export declare const SimpleField: default_2.FC<{
     item: DialobItem;
 } & Record<string, any>>;
 
+export { StyledTable }
+
 export declare const TranslationDialog: default_2.FC<{
     open: boolean;
     onClose: () => void;
@@ -531,6 +588,66 @@ export declare const UploadValuesetDialog: default_2.FC<{
     setCurrentValueSet: default_2.Dispatch<default_2.SetStateAction<ValueSet | undefined>>;
 }>;
 
+export declare const useComposer: () => {
+    addItem: (itemTemplate: DialobItemTemplate, parentItemId: string, afterItemId?: string, callbacks?: ComposerCallbacks) => void;
+    updateItem: (itemId: string, attribute: string, value: string, language?: string) => void;
+    updateLocalizedString: (itemId: string, attribute: string, value: LocalizedString, index?: number) => void;
+    changeItemType: (itemId: string, config: DialobItemTemplate) => void;
+    deleteItem: (itemId: string) => void;
+    setItemProp: (itemId: string, key: string, value: any) => void;
+    deleteItemProp: (itemId: string, key: string) => void;
+    moveItem: (itemId: string, fromIndex: number, toIndex: number, fromParent: string, toParent: string) => void;
+    createValidation: (itemId: string, rule?: ValidationRule) => void;
+    setValidationMessage: (itemId: string, index: number, language: string, message: string) => void;
+    setValidationExpression: (itemId: string, index: number, expression: string) => void;
+    deleteValidation: (itemId: string, index: number) => void;
+    createValueSet: (itemId: string | null, entries?: ValueSetEntry[]) => void;
+    setValueSetEntries: (valueSetId: string, entries: ValueSetEntry[]) => void;
+    addValueSetEntry: (valueSetId: string, entry?: ValueSetEntry) => void;
+    updateValueSetEntry: (valueSetId: string, index: number, entry: ValueSetEntry) => void;
+    updateValueSetEntryLabel: (valueSetId: string, index: number, text: string | null, language: string) => void;
+    deleteValueSetEntry: (valueSetId: string, index: number) => void;
+    moveValueSetEntry: (valueSetId: string, from: number, to: number) => void;
+    setGlobalValueSetName: (valueSetId: string, name: string) => void;
+    deleteGlobalValueSet: (valueSetId: string) => void;
+    deleteLocalValueSet: (valueSetId: string) => void;
+    setMetadataValue: (attr: string, value: any) => void;
+    setContextValue: (name: string, value: string) => void;
+    createVariable: (context: boolean) => void;
+    updateContextVariable: (variableId: string, contextType?: ContextVariableType | string, defaultValue?: any) => void;
+    updateExpressionVariable: (variableId: string, expression: string) => void;
+    updateVariablePublishing: (variableId: string, published: boolean) => void;
+    updateVariableDescription: (variableId: string, description: string) => void;
+    deleteVariable: (variableId: string) => void;
+    moveVariable: (origin: ContextVariable | Variable, destination: ContextVariable | Variable) => void;
+    addLanguage: (language: string, copyFrom?: string) => void;
+    deleteLanguage: (language: string) => void;
+    setForm: (form: ComposerState, tagName?: string, save?: boolean) => void;
+    setRevision: (revision: string) => void;
+    applyItemChanges: (newState: SavingState) => void;
+    applyListChanges: (newState: SavingState) => void;
+    applyVariableChanges: (newState: SavingState) => void;
+    form: ComposerState;
+};
+
+export declare const useEditor: () => {
+    editor: EditorState;
+    setActivePage: (page: DialobItem) => void;
+    setActiveFormLanguage: (language: string) => void;
+    setErrors: (errors: EditorError[]) => void;
+    clearErrors: () => void;
+    setActiveItem: (item?: DialobItem) => void;
+    setConfirmationDialogType: (dialogType?: ConfirmationDialogType) => void;
+    setItemOptionsActiveTab: (tab?: OptionsTabType) => void;
+    setHighlightedItem: (item?: DialobItem) => void;
+    setActiveList: (listId?: string) => void;
+    setActiveVariableTab: (tab?: VariableTabType) => void;
+};
+
+declare const useErrorColor: (error: EditorError | undefined) => string | undefined;
+
+declare const useErrorColorSx: (errors: EditorError[] | undefined, itemId: string) => string | undefined;
+
 declare type ValidationRule = {
     message?: LocalizedString;
     rule?: string;
@@ -564,8 +681,8 @@ declare type Variable = {
 };
 
 declare interface VariableProps {
-    item: TreeItem;
-    provided: TreeDraggableProvided;
+    index: number;
+    item: Variable | ContextVariable;
     onClose: () => void;
 }
 
@@ -574,6 +691,8 @@ export declare const VariablesDialog: default_2.FC<{
     onClose: () => void;
 }>;
 
+declare type VariableTabType = 'context' | 'expression';
+
 export declare const VersioningDialog: default_2.FC<{
     open: boolean;
     onClose: () => void;