@zextras/carbonio-admin-ui/types/misc/index.d.ts

The Zextras Carbonio web admin

/*
 * SPDX-FileCopyrightText: 2021 Zextras <https://www.zextras.com>
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { ComponentType } from 'react';

import { Store } from '@reduxjs/toolkit';
import { To } from 'history';
import { i18n } from 'i18next';

import { DARK_READER_VALUES } from '../../src/constants';
import { CarbonioModule, PanelMode } from '../apps';

export interface II18nFactory {
	_cache: { [pkg: string]: i18n };
	locale: string;
	setLocale(locale: string): void;
	getShellI18n(): i18n;
	getAppI18n(appPkgDescription: CarbonioModule): i18n;
}

export type DRPropValues = 'auto' | 'enabled' | 'disabled';

// eslint-disable-next-line @typescript-eslint/ban-types
export type PackageDependentFunction = (app: string) => Function;
// eslint-disable-next-line @typescript-eslint/ban-types

export type ContextBridgeState = {
	packageDependentFunctions: Record<string, PackageDependentFunction>;
	// eslint-disable-next-line @typescript-eslint/ban-types
	functions: Record<string, Function>;
	add: (content: Partial<Omit<ContextBridgeState, 'add'>>) => void;
};

export type IShellWindow = Window & {
	__ZAPP_SHARED_LIBRARIES__: { [name: string]: any };
	__ZAPP_HMR_EXPORT__: { [pkgName: string]: (appClass: ComponentType) => void };
	// __ZAPP_HMR_HANDLERS__: { [pkgName: string]: (handlers: RequestHandlersList) => void };
};

export type LoadedAppRuntime = AppInjections & {
	pkg: CarbonioModule;
};

export type LoadedAppsCache = {
	[pkgName: string]: LoadedAppRuntime;
};

export type AppInjections = {
	store: Store<any>;
};

export type HistoryParams =
	| {
			path: To;
			route?: string;
	  }
	| string;
export type UtilityBarStore = {
	mode: PanelMode;
	setMode: (mode: PanelMode) => void;
	current?: string;
	setCurrent: (current: string) => void;
	secondaryBarState: boolean;
	setSecondaryBarState: (state: boolean) => void;
	primaryBarState: boolean;
	setPrimaryBarState: (state: boolean) => void;
};

export type AccountProps = {
	accountId?: string;
	type?: string;
	id?: number;
	email?: string;
	label?: string;
	personaLabel?: string;
	identityId?: string;
};

export type IdentityProps = {
	id: string;
	type: string;
	identityId: string | number;
	fromAddress?: string;
	identityName?: string;
	fromDisplay?: string;
	recoveryAccount?: string;
	replyToDisplay?: string;
	replyToAddress?: string;
	replyToEnabled?: string;
	saveToSent?: string;
	sentMailFolder?: string;
	whenInFoldersEnabled?: string;
	whenSentToEnabled?: string;
	whenSentToAddresses?: string;
};

export type Folder = {
	id: string;
	uuid: string;
	name: string;
	path: string | undefined;
	parent: string;
	parentUuid: string;
	unreadCount: number;
	size: number;
	itemsCount: number;
	synced: boolean;
	absParent: string;
	items: Folder[];
	level: number;
	to: string;
	color: string;
	rgb: string;
	rid?: string;
	isSharedFolder?: boolean;
	owner?: string;
	zid?: string;
	acl?: unknown;
	perm?: string;
	retentionPolicy?: unknown;
};

export type CreateModalProps = {
	background: string;
	centered: boolean;
	children: React.ReactElement;
	confirmColor: string;
	confirmLabel: string;
	copyLabel: string;
	customFooter: React.ReactElement;
	disablePortal: boolean;
	dismissLabel: string;
	hideFooter: boolean;
	maxHeight: string;
	onClose: () => void;
	onConfirm: () => void;
	onSecondaryAction: () => void;
	optionalFooter: React.ReactElement;
	secondaryActionLabel: string;
	showCloseIcon: boolean;
	size: string;
	title: string;
	type: string;
	zIndex: number;
};

export type DarkReaderPropValues = (typeof DARK_READER_VALUES)[number];

export function isDarkReaderPropValues(
	maybeDarkReaderPropValue: unknown
): maybeDarkReaderPropValue is DarkReaderPropValues {
	return (
		typeof maybeDarkReaderPropValue === 'string' &&
		DARK_READER_VALUES.includes(maybeDarkReaderPropValue)
	);
}