@dialob/composer-material 0.0.2

package/dist-lib/index.d.ts

@@ -0,0 +1,615 @@
+import { default as default_2 } from 'react';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { LabelField } from '../items/ItemComponents';
+import { LanguageEditor } from '../components/translations/LanguageEditor';
+import { default as NavigationTreeItem } from '../components/tree/NavigationTreeItem';
+import { SvgIconProps } from '@mui/material';
+import { TreeDraggableProvided } from '@atlaskit/tree/dist/types/components/TreeItem/TreeItem-types';
+import { TreeItem } from '@atlaskit/tree';
+import { VisibilityField } from '../items/ItemComponents';
+
+declare interface ApiResponse {
+    success: boolean;
+    result?: SaveResult | DuplicateResult | CreateTagResult | ChangeIdResult | CreateSessionResult;
+    apiError?: any;
+}
+
+declare interface AppConfig {
+    formId: string;
+    csrfHeader: string;
+    csrf: string;
+    backend_api_url: string;
+    filling_app_url: string;
+    adminAppUrl: string;
+    tenantId: string;
+    credentialMode: RequestCredentials;
+    version: string;
+}
+
+declare interface BackendState {
+    formId: string;
+    loaded: boolean;
+    form: ComposerState | null;
+    config: DialobComposerConfig;
+    loadForm(formId: string, tagName?: string): Promise<ComposerState>;
+    saveForm(form: ComposerState, dryRun?: boolean): Promise<ApiResponse>;
+    createForm(form: ComposerState): Promise<ApiResponse>;
+    duplicateItem(form: ComposerState, itemId: string): Promise<ApiResponse>;
+    createTag(request: CreateTagRequest): Promise<ApiResponse>;
+    getTags(formName: string): Promise<ComposerTag[]>;
+    changeItemId(form: ComposerState, oldId: string, newId: string): Promise<ApiResponse>;
+    createPreviewSession(formId: string, language: string, context?: PreviewSessionContext): Promise<ApiResponse>;
+}
+
+declare namespace BackendTypes {
+    export {
+        SaveResult,
+        DuplicateResult,
+        ChangeIdResult,
+        CreateTagResult,
+        CreateSessionResult,
+        ApiResponse,
+        CreateTagRequest,
+        PreviewSessionContext,
+        PreviewSessionData,
+        TransportConfig,
+        DialobComposerConfig,
+        AppConfig,
+        BackendState
+    }
+}
+export { BackendTypes }
+
+declare const BoolProp: (props: any) => JSX_2.Element;
+
+declare interface CategoryItem {
+    title: string;
+    optionEditors?: OptionEditor[];
+    propEditors?: PropEditorsType;
+    convertible?: DialobItemType[];
+    config: DialobItemTemplate;
+}
+
+declare interface ChangeIdResult {
+    ok: boolean;
+    id: string;
+    rev: string;
+    form: ComposerState;
+    errors: EditorError[];
+}
+
+export declare const ChoiceDeleteDialog: default_2.FC<{
+    open: boolean;
+    itemId: string;
+    onClick: () => void;
+    onClose: () => void;
+}>;
+
+export declare const ChoiceEditor: default_2.FC;
+
+export declare const ChoiceItem: default_2.FC<ChoiceItemProps>;
+
+declare interface ChoiceItemProps {
+    item: TreeItem;
+    valueSetId?: string;
+    provided: TreeDraggableProvided;
+    isGlobal?: boolean;
+    expanded: string[];
+    onToggleExpand: (id: string) => void;
+    onRuleEdit: (entry: ValueSetEntry, rule: string) => void;
+    onTextEdit: (entry: ValueSetEntry, label: LocalizedString) => void;
+    onDelete: (entry: ValueSetEntry) => void;
+    onUpdateId: (entry: ValueSetEntry, id: string) => void;
+}
+
+export declare const ChoiceList: default_2.FC<{
+    valueSet?: ValueSet;
+    updateValueSet: (value: default_2.SetStateAction<ValueSet | undefined>) => void;
+    isGlobal?: boolean;
+}>;
+
+declare const ChoiceProp: (props: any) => JSX_2.Element;
+
+declare type ComposerCallbacks = {
+    onAddItem?: (state: ComposerState, item: DialobItem) => void;
+};
+
+declare type ComposerState = {
+    _id?: string;
+    _rev?: string;
+    _tag?: string;
+    name: string;
+    data: {
+        [item: string]: DialobItem;
+    };
+    variables?: (Variable | ContextVariable)[];
+    valueSets?: ValueSet[];
+    metadata: {
+        label?: string;
+        labels?: string[];
+        showDisabled?: boolean;
+        questionClientVisibility?: VisibilityType;
+        answersRequiredByDefault?: boolean;
+        creator?: string;
+        tenantId?: string;
+        savedBy?: string;
+        languages?: string[];
+        valid?: boolean;
+        created?: string;
+        lastSaved?: string;
+        composer?: {
+            globalValueSets?: {
+                label?: string;
+                valueSetId: string;
+            }[];
+            contextValues?: {
+                [name: string]: string;
+            };
+        };
+        [prop: string]: any;
+    };
+};
+
+declare type ComposerTag = {
+    name: string;
+    formName: string;
+    formId?: string;
+    description?: string;
+    created?: string;
+    type: 'NORMAL' | 'MUTABLE';
+    creator?: string;
+};
+
+declare interface ConfigItemProps {
+    icon: React.ComponentType<SvgIconProps>;
+    placeholder: string;
+    treeCollapsible?: boolean;
+    style?: 'normal' | 'success' | 'info' | 'warning' | 'error';
+    [key: string]: any;
+}
+
+export declare const ConfirmationDialog: default_2.FC;
+
+declare type ContextVariable = {
+    name: string;
+    published?: boolean;
+    defaultValue?: any;
+    context: boolean;
+    contextType: ContextVariableType | string;
+    description?: string;
+};
+
+export declare const ContextVariableRow: default_2.FC<VariableProps>;
+
+export declare const ContextVariables: default_2.FC<{
+    onClose: () => void;
+}>;
+
+declare type ContextVariableType = 'text' | 'number' | 'decimal' | 'boolean' | 'date' | 'time';
+
+export declare const ConvertConfirmationDialog: default_2.FC<{
+    type: 'local' | 'global' | undefined;
+    onClick: () => void;
+    onClose: () => void;
+}>;
+
+declare interface CreateSessionResult {
+    _id: string;
+    _rev: string;
+}
+
+export declare const CreateTagDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+declare interface CreateTagRequest {
+    name: string;
+    description: string;
+    formName: string;
+    formId?: string;
+}
+
+declare interface CreateTagResult {
+    ok: boolean;
+}
+
+export declare const DEFAULT_ITEM_CONFIG: ItemConfig;
+
+export declare const DEFAULT_ITEMTYPE_CONFIG: ItemTypeConfig;
+
+export declare const DEFAULT_VALUESET_PROPS: ValueSetProp[];
+
+declare namespace DefaultTypes {
+    export {
+        ItemConfig,
+        ItemConfigItem,
+        ConfigItemProps,
+        ItemTypeConfig,
+        ItemTypeCategory,
+        CategoryItem,
+        OptionEditor,
+        PropEditorsType
+    }
+}
+export { DefaultTypes }
+
+export declare const DefaultValueEditor: default_2.FC;
+
+export declare const DescriptionEditor: default_2.FC;
+
+declare type DialobCategoryType = 'structure' | 'input' | 'output';
+
+export declare const DialobComposer: React.FC<{
+    config: DialobComposerConfig;
+    formId: string;
+}>;
+
+declare interface DialobComposerConfig {
+    transport: TransportConfig;
+    documentationUrl?: string;
+    itemEditors?: ItemConfig;
+    itemTypes?: ItemTypeConfig;
+    backendVersion: string;
+    closeHandler: () => void;
+}
+
+declare type DialobItem = DialobItemTemplate & {
+    id: string;
+};
+
+declare type DialobItems = {
+    [key: string]: DialobItem;
+};
+
+declare type DialobItemTemplate = {
+    type: DialobItemType | string;
+    view?: string;
+    label?: LocalizedString;
+    description?: LocalizedString;
+    required?: string;
+    valueSetId?: string;
+    activeWhen?: string;
+    canAddRowWhen?: string;
+    canRemoveRowWhen?: string;
+    items?: string[];
+    className?: string[];
+    props?: {
+        [prop: string]: any;
+    };
+    validations?: ValidationRule[];
+    [prop: string]: any;
+};
+
+declare type DialobItemType = 'questionnaire' | 'group' | 'text' | 'number' | 'boolean' | 'multichoice' | 'survey' | 'surveygroup' | 'list' | 'note' | 'date' | 'time' | 'decimal' | 'row' | 'rowgroup' | 'verticalSurveygroup' | 'address' | 'textBox' | 'page';
+
+declare namespace DialobTypes {
+    export {
+        LocalizedString,
+        Variable,
+        ContextVariableType,
+        ContextVariable,
+        ValueSetEntry,
+        ValueSet,
+        DialobItemType,
+        DialobCategoryType,
+        ValidationRule,
+        DialobItemTemplate,
+        DialobItem,
+        DialobItems,
+        VisibilityType,
+        ComposerTag,
+        ComposerState,
+        INIT_STATE,
+        ComposerCallbacks
+    }
+}
+export { DialobTypes }
+
+declare interface DuplicateResult {
+    ok: boolean;
+    id: string;
+    rev: string;
+    form: ComposerState;
+}
+
+export declare const Editor: default_2.FC;
+
+declare type EditorError = {
+    level: ErrorSeverity;
+    message: string;
+    type?: string;
+    itemId?: string;
+    expression?: string;
+    startIndex?: number;
+    endIndex?: number;
+    index?: number;
+};
+
+declare type ErrorSeverity = 'ERROR' | 'WARNING' | 'INFO' | 'FATAL';
+
+export declare const ExpressionVariableRow: default_2.FC<VariableProps>;
+
+export declare const ExpressionVariables: default_2.FC<{
+    onClose: () => void;
+}>;
+
+export declare const FormOptionsDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+export declare const GlobalList: default_2.FC<{
+    entries?: ValueSetEntry[];
+}>;
+
+export declare const GlobalListsDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+export declare const Group: default_2.FC<{
+    item: DialobItem;
+} & Record<string, any>>;
+
+declare interface IndexedRule {
+    index: number;
+    validationRule: ValidationRule;
+}
+
+declare const INIT_STATE: ComposerState;
+
+declare const InputProp: (props: any) => JSX_2.Element;
+
+declare interface ItemConfig {
+    defaultIcon: React.ComponentType<SvgIconProps>;
+    items: ItemConfigItem[];
+}
+
+declare interface ItemConfigItem {
+    matcher: (item: DialobItem) => boolean;
+    component: React.FC<{
+        item: DialobItem;
+    } & Record<string, any>>;
+    props: ConfigItemProps;
+}
+
+export declare const itemFactory: (item: DialobItem, itemConfig?: ItemConfig, props?: any) => JSX_2.Element | null;
+
+export declare const ItemOptionsDialog: default_2.FC;
+
+declare interface ItemProp {
+    key: string;
+    value: PropValue;
+}
+
+declare interface ItemTypeCategory {
+    title: string;
+    type: DialobCategoryType;
+    items: CategoryItem[];
+}
+
+declare interface ItemTypeConfig {
+    categories: ItemTypeCategory[];
+}
+
+export declare const LabelEditor: default_2.FC;
+
+export { LabelField }
+
+export { LanguageEditor }
+
+declare type LocalizedString = {
+    [language: string]: string;
+};
+
+export declare const LocalizedStringEditor: default_2.FC<{
+    type: 'label' | 'description' | 'validations';
+    rule?: IndexedRule;
+    setRule?: default_2.Dispatch<default_2.SetStateAction<IndexedRule | undefined>>;
+}>;
+
+export declare const MissingTranslations: default_2.FC;
+
+declare const MultiChoiceProp: (props: any) => JSX_2.Element;
+
+export { NavigationTreeItem }
+
+export declare const NavigationTreeView: default_2.FC;
+
+export declare const Note: default_2.FC<{
+    item: DialobItem;
+} & Record<string, any>>;
+
+declare interface OptionEditor {
+    name: string;
+    editor: React.FC;
+}
+
+export declare const PageTabs: default_2.FC<{
+    items: DialobItems;
+}>;
+
+export declare const PreviewDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+declare type PreviewSessionContext = {
+    id: string;
+    value: any;
+}[];
+
+declare interface PreviewSessionData {
+    metadata: {
+        formId: string;
+        formRev: string;
+        language: string;
+    };
+    context?: PreviewSessionContext;
+}
+
+declare namespace PropEditors {
+    export {
+        InputProp,
+        MultiChoiceProp,
+        ChoiceProp,
+        BoolProp
+    }
+}
+export { PropEditors }
+
+declare interface PropEditorsType {
+    [key: string]: {
+        component: any;
+        props?: any;
+    };
+}
+
+export declare const PropertiesEditor: default_2.FC;
+
+export declare const PropItem: default_2.FC<{
+    prop: ItemProp;
+    propEditor: {
+        component: any;
+        props?: any;
+    } | undefined;
+    onEdit: (key: string, value: PropValue) => void;
+    onDelete: (key: string) => void;
+}>;
+
+declare type PropValue = string | string[] | boolean;
+
+export declare const RuleEditor: default_2.FC<{
+    type: RuleType;
+}>;
+
+export declare const RulesEditor: default_2.FC;
+
+declare type RuleType = 'visibility' | 'requirement' | 'canaddrow' | 'canremoverow';
+
+declare interface SaveResult {
+    ok: boolean;
+    id: string;
+    rev: string;
+    errors: EditorError[];
+}
+
+export declare const SimpleField: default_2.FC<{
+    item: DialobItem;
+} & Record<string, any>>;
+
+export declare const TranslationDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+export declare const TranslationFileEditor: default_2.FC;
+
+declare interface TransportConfig {
+    csrf?: {
+        headerName: string;
+        token: string;
+    };
+    apiUrl: string;
+    previewUrl: string;
+    tenantId?: string;
+    credentialMode?: RequestCredentials;
+}
+
+export declare const UploadValuesetDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+    currentValueSet: ValueSet | undefined;
+    setCurrentValueSet: default_2.Dispatch<default_2.SetStateAction<ValueSet | undefined>>;
+}>;
+
+declare type ValidationRule = {
+    message?: LocalizedString;
+    rule?: string;
+};
+
+export declare const ValidationRuleEditor: default_2.FC;
+
+declare type ValueSet = {
+    id: string;
+    entries?: ValueSetEntry[];
+};
+
+declare type ValueSetEntry = {
+    id: string;
+    label: LocalizedString;
+    when?: string;
+    [prop: string]: any;
+};
+
+declare interface ValueSetProp {
+    title: string;
+    name: string;
+    editor: React.FC;
+}
+
+declare type Variable = {
+    name: string;
+    published?: boolean;
+    expression: string;
+    description?: string;
+};
+
+declare interface VariableProps {
+    item: TreeItem;
+    provided: TreeDraggableProvided;
+    onClose: () => void;
+}
+
+export declare const VariablesDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+export declare const VersioningDialog: default_2.FC<{
+    open: boolean;
+    onClose: () => void;
+}>;
+
+export { VisibilityField }
+
+declare type VisibilityType = 'ONLY_ENABLED' | 'SHOW_DISABLED' | 'ALL';
+
+export { }
+
+
+declare module '@mui/material/styles' {
+    interface Palette {
+        article: Palette['primary'];
+        page: Palette['primary'];
+        link: Palette['primary'];
+        workflow: Palette['primary'];
+        release: Palette['primary'];
+        locale: Palette['primary'];
+        import: Palette['primary'];
+        activeItem: Palette['primary'];
+        save: Palette['primary'];
+        explorer: Palette['primary'];
+        explorerItem: Palette['primary'];
+        mainContent: Palette['primary'];
+        uiElements: Palette['primary'];
+        table: Palette['primary'];
+    }
+    interface PaletteOptions {
+        article: Palette['primary'];
+        page: Palette['primary'];
+        link: Palette['primary'];
+        workflow: Palette['primary'];
+        release: Palette['primary'];
+        locale: Palette['primary'];
+        import: Palette['primary'];
+        activeItem: Palette['primary'];
+        save: Palette['primary'];
+        explorer: Palette['primary'];
+        explorerItem: Palette['primary'];
+        mainContent: Palette['primary'];
+        uiElements: Palette['primary'];
+        table: Palette['primary'];
+    }
+}