@zextras/carbonio-shell-ui 6.0.0 → 7.0.0

package/lib/types/account/index.d.ts

@@ -0,0 +1,140 @@
+import type { DELEGATED_SEND_SAVE_TARGET } from '../../constants';
+import type { StringOfLength } from '../../utils/typeUtils';
+export interface ZimletProp {
+    name: string;
+    zimlet: string;
+    _content: string;
+}
+export type AccountState = {
+    authenticated: boolean;
+    account?: Account;
+    settings: AccountSettings;
+    zimbraVersion?: string;
+    usedQuota: number;
+};
+export interface Identity {
+    /** Identity name */
+    name?: string;
+    /** Identity ID */
+    id: string;
+    /** Attributes */
+    _attrs: IdentityAttrs;
+}
+export type Account = {
+    id: string;
+    name: string;
+    displayName: string;
+    signatures: {
+        signature: Array<unknown>;
+    };
+    identities: {
+        identity: Array<Identity>;
+    };
+    rights: AccountRights;
+};
+export type BooleanString = 'TRUE' | 'FALSE';
+type GeneralizedTimeObj = {
+    year: `${number}` & StringOfLength<4>;
+    month: `${number}` & StringOfLength<2>;
+    date: `${number}` & StringOfLength<2>;
+    hour: `${number}` & StringOfLength<2>;
+    min: `${number}` & StringOfLength<2>;
+    sec: `${number}` & StringOfLength<2>;
+    ms: (`.${number}` & StringOfLength<4>) | '';
+    timezone: 'Z' | '';
+};
+/**
+ * A GeneralizedTime is a string representing a date in UTC with the format YYYYMMDDHHmmss[.SSS][Z]
+ */
+export type GeneralizedTime = `${GeneralizedTimeObj['year']}${GeneralizedTimeObj['month']}${GeneralizedTimeObj['date']}${GeneralizedTimeObj['hour']}${GeneralizedTimeObj['min']}${GeneralizedTimeObj['sec']}${GeneralizedTimeObj['ms']}${GeneralizedTimeObj['timezone']}`;
+export type DurationUnit = 'd' | 'h' | 'm' | 's' | 'ms';
+export type Duration = `${number}${DurationUnit | ''}`;
+export interface AccountSettingsPrefs {
+    zimbraPrefOutOfOfficeExternalReply?: string;
+    zimbraPrefOutOfOfficeReply?: string;
+    zimbraPrefOutOfOfficeReplyEnabled?: BooleanString;
+    zimbraPrefOutOfOfficeExternalReplyEnabled?: BooleanString;
+    zimbraPrefExternalSendersType?: 'ALL' | 'ALLNOTINAB' | 'INAB' | 'INSD';
+    zimbraPrefOutOfOfficeSuppressExternalReply?: BooleanString;
+    zimbraPrefOutOfOfficeFreeBusyStatus?: 'BUSY' | 'OUTOFOFFICE';
+    zimbraPrefOutOfOfficeStatusAlertOnLogin?: BooleanString;
+    zimbraPrefIncludeSharedItemsInSearch?: BooleanString;
+    zimbraPrefIncludeSpamInSearch?: BooleanString;
+    zimbraPrefIncludeTrashInSearch?: BooleanString;
+    zimbraPrefOutOfOfficeFromDate?: GeneralizedTime;
+    zimbraPrefOutOfOfficeUntilDate?: GeneralizedTime;
+    zimbraPrefHtmlEditorDefaultFontColor?: string;
+    zimbraPrefHtmlEditorDefaultFontFamily?: string;
+    zimbraPrefHtmlEditorDefaultFontSize?: string;
+    zimbraPrefLocale?: string;
+    zimbraPrefMailPollingInterval?: Duration;
+    zimbraPrefMailTrustedSenderList?: Array<string> | string;
+    zimbraPrefDelegatedSendSaveTarget?: (typeof DELEGATED_SEND_SAVE_TARGET)[number];
+    /**
+     * @deprecated the timezone preference is going to be removed, because now we rely on the system timezone.
+     */
+    zimbraPrefTimeZoneId?: string;
+    [key: string]: string | number | Array<string | number> | undefined;
+}
+export type AccountSettingsAttrs = {
+    zimbraFeatureOptionsEnabled?: BooleanString;
+    zimbraIdentityMaxNumEntries?: number;
+    [key: string]: string | number | Array<string | number> | undefined;
+};
+export type AccountSettings = {
+    attrs: AccountSettingsAttrs;
+    prefs: AccountSettingsPrefs;
+    props: Array<ZimletProp>;
+};
+export interface IdentityAttrs {
+    /** default mail signature for account/identity/dataSource */
+    zimbraPrefDefaultSignatureId?: string;
+    zimbraPrefForwardReplyFormat?: `'text' | 'html' | 'same'`;
+    /** forward/reply signature id for account/identity/dataSource */
+    zimbraPrefForwardReplySignatureId?: string;
+    /** email address to put in from header.  Deprecated on data source as of bug 67068. */
+    zimbraPrefFromAddress?: string;
+    /** Type of the email address from header. (sendAs or sendOnBehalfOf)  */
+    zimbraPrefFromAddressType?: 'sendAs' | 'sendOnBehalfOf';
+    /** personal part of email address put in from header */
+    zimbraPrefFromDisplay?: string;
+    zimbraPrefIdentityId?: string;
+    /** name of the identity */
+    zimbraPrefIdentityName?: string;
+    zimbraPrefMailSignatureStyle?: 'outlook' | 'internet';
+    /** address to put in reply-to header */
+    zimbraPrefReplyToAddress?: string;
+    /** personal part of email address put in reply-to header */
+    zimbraPrefReplyToDisplay?: string;
+    /** TRUE if we should set a reply-to header */
+    zimbraPrefReplyToEnabled?: BooleanString;
+    /** name of folder to save sent mail in (deprecatedSince 5.0 in identity) */
+    zimbraPrefSentMailFolder?: string;
+    zimbraPrefWhenInFolderIds?: Array<string | null>;
+    /** TRUE if we should look at zimbraPrefWhenInFolderIds (deprecatedSince 5.0 in account) */
+    zimbraPrefWhenInFoldersEnabled?: BooleanString;
+    /** addresses that we will look at to see if we should use an identity (deprecatedSince 5.0 in account) */
+    zimbraPrefWhenSentToAddresses?: Array<string | null>;
+    /** TRUE if we should look at zimbraPrefWhenSentToAddresses (deprecatedSince 5.0 in account) */
+    zimbraPrefWhenSentToEnabled?: BooleanString;
+    /** whether or not to save outgoing mail (deprecatedSince 5.0 in identity) */
+    zimbraPrefSaveToSent?: BooleanString;
+}
+export type AccountRightTargetEmail = {
+    addr: string;
+};
+export type AccountRightTarget = {
+    d: string;
+    id: string;
+    name: string;
+    type: string;
+    email: Array<AccountRightTargetEmail>;
+};
+export type AccountRightName = 'sendAs' | 'sendAsDistList' | 'viewFreeBusy' | 'sendOnBehalfOf' | 'sendOnBehalfOfDistList';
+export type AccountRights = {
+    targets: Array<{
+        right: AccountRightName;
+        target: Array<AccountRightTarget>;
+    }>;
+};
+export {};

package/lib/types/account/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/*
+ * SPDX-FileCopyrightText: 2021 Zextras <https://www.zextras.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/account/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/account/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/lib/types/apps/index.d.ts

@@ -0,0 +1,120 @@
+import type { ComponentType, FC } from 'react';
+import type React from 'react';
+import type { DefaultTheme } from 'styled-components';
+import type { QueryChip } from '../search';
+export type CarbonioModule = {
+    commit: string;
+    description: string;
+    js_entrypoint: string;
+    name: string;
+    priority: number;
+    version: string;
+    type: 'carbonio' | 'shell';
+    attrKey?: string;
+    icon: string;
+    display: string;
+    sentryDsn?: string;
+};
+export type AppRoute = {
+    id: string;
+    route: string;
+    app: string;
+    focusMode?: boolean;
+};
+export type BadgeInfo = {
+    show: boolean;
+    count?: number;
+    showCount?: boolean;
+    color?: keyof DefaultTheme['palette'];
+};
+export type CarbonioView<P> = {
+    id: string;
+    app: string;
+    route: string;
+    component: ComponentType<P>;
+};
+export type CarbonioAccessoryView<P> = {
+    id: string;
+    app: string;
+    whitelistRoutes?: Array<string>;
+    blacklistRoutes?: Array<string>;
+    position: number;
+    component: ComponentType<P>;
+};
+export type PrimaryBarComponentProps = {
+    active: boolean;
+};
+export type SecondaryBarComponentProps = {
+    expanded: boolean;
+};
+export type AppViewComponentProps = {};
+export type BoardViewComponentProps = {
+    windowHistory: History;
+};
+export type SettingsViewProps = {};
+export type SearchViewProps = {
+    useQuery: () => [QueryChip[], Function];
+    ResultsHeader: FC<{
+        label: string;
+    }>;
+    useDisableSearch: () => [boolean, Function];
+};
+export type PrimaryAccessoryViewProps = {};
+export type SecondaryAccessoryViewProps = {
+    expanded: boolean;
+};
+export type PanelMode = 'closed' | 'overlap' | 'open';
+export type UtilityBarComponentProps = {
+    mode: PanelMode;
+    setMode: (mode: PanelMode) => void;
+};
+export type PrimaryBarView = Omit<CarbonioView<PrimaryBarComponentProps>, 'component'> & {
+    component: string | ComponentType<PrimaryBarComponentProps>;
+    badge: BadgeInfo;
+    position: number;
+    visible: boolean;
+    label: string;
+};
+export type SecondaryBarView = CarbonioView<SecondaryBarComponentProps>;
+export type AppView = CarbonioView<AppViewComponentProps>;
+export type BoardView = CarbonioView<BoardViewComponentProps>;
+export type UtilityView = CarbonioAccessoryView<UtilityBarComponentProps> & {
+    button: string | ComponentType<UtilityBarComponentProps>;
+    component: ComponentType<UtilityBarComponentProps>;
+    badge: BadgeInfo;
+    label: string;
+};
+export type SettingsSubSection = {
+    label: string;
+    id: string;
+};
+export type SettingsView = CarbonioView<SettingsViewProps> & {
+    icon: string;
+    label: string;
+    position: number;
+    subSections?: Array<SettingsSubSection>;
+};
+export type SearchView = CarbonioView<SearchViewProps> & {
+    icon: string;
+    label: string;
+    position: number;
+};
+export type PrimaryAccessoryView = CarbonioAccessoryView<PrimaryAccessoryViewProps> & {
+    component: string | ComponentType;
+    onClick?: (ev: KeyboardEvent | React.MouseEvent<HTMLButtonElement> | undefined) => void;
+    label: string;
+};
+export type SecondaryAccessoryView = CarbonioAccessoryView<SecondaryAccessoryViewProps>;
+export type AppRouteDescriptor = {
+    id: string;
+    route: string;
+    app: string;
+    primaryBar: string | ComponentType<PrimaryBarComponentProps>;
+    badge: BadgeInfo;
+    position: number;
+    visible: boolean;
+    label: string;
+    secondaryBar?: ComponentType<SecondaryBarComponentProps>;
+    appView: ComponentType<AppViewComponentProps>;
+    focusMode?: boolean;
+};

package/lib/types/apps/index.js

@@ -0,0 +1,9 @@
+"use strict";
+/* eslint-disable @typescript-eslint/ban-types */
+/*
+ * SPDX-FileCopyrightText: 2021 Zextras <https://www.zextras.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/apps/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/apps/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD;;;;GAIG"}

package/lib/types/boards/index.d.ts

@@ -0,0 +1,10 @@
+export type Board<T = unknown> = {
+    id: string;
+    url: string;
+    app: string;
+    icon: string;
+    title: string;
+    context?: T;
+    onClose?: (board: Board<T>) => void;
+    onGoToPanel?: (board: Board<T>) => void;
+};

package/lib/types/boards/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/boards/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/boards/index.ts"],"names":[],"mappings":""}

package/lib/types/folder/index.d.ts

@@ -0,0 +1,29 @@
+import type { BaseFolder, LinkFolderFields, SearchFolderFields } from '../misc';
+export type FolderFields = {
+    isLink: boolean;
+    depth: number;
+    parent?: Folder;
+    children: Array<Folder>;
+};
+export type UserFolder = BaseFolder & FolderFields & {
+    isLink: false;
+};
+export type LinkFolder = BaseFolder & FolderFields & LinkFolderFields & {
+    isLink: true;
+};
+export type SearchFolder = BaseFolder & Pick<FolderFields, 'parent' | 'isLink'> & SearchFolderFields;
+export type Folder = UserFolder | LinkFolder;
+export type Folders = {
+    [id: string]: Folder;
+};
+export type Roots = {
+    [id: string]: Folder;
+};
+export type Searches = {
+    [id: string]: SearchFolder;
+};
+export type FolderState = {
+    folders: Folders;
+    roots: Roots;
+    searches: Searches;
+};

package/lib/types/folder/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/*
+ * SPDX-FileCopyrightText: 2022 Zextras <https://www.zextras.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/folder/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/folder/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/lib/types/integrations/index.d.ts

@@ -0,0 +1,8 @@
+import type { DropdownItem } from '@zextras/carbonio-design-system';
+export type Action = DropdownItem & {
+    primary?: boolean;
+    group?: string;
+    /** @deprecated use onClick instead */
+    click?: DropdownItem['onClick'];
+};
+export type ActionFactory<T> = (target: T) => Action;

package/lib/types/integrations/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/*
+ * SPDX-FileCopyrightText: 2021 Zextras <https://www.zextras.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/integrations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/integrations/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/lib/types/misc/index.d.ts

@@ -0,0 +1,156 @@
+import type { ComponentType } from 'react';
+import type { Store } from '@reduxjs/toolkit';
+import type { To } from 'history';
+import type { CarbonioModule, PanelMode } from '../apps';
+import type { Folder } from '../folder';
+export type LoadedAppRuntime = AppInjections & {
+    pkg: CarbonioModule;
+};
+export type LoadedAppsCache = {
+    [pkgName: string]: LoadedAppRuntime;
+};
+export type AppInjections = {
+    store: Store;
+};
+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;
+};
+export type AccountProps = {
+    accountId?: string;
+    type?: string;
+    id?: number;
+    email?: string;
+    label?: string;
+    personaLabel?: string;
+    identityId?: string;
+};
+/** @deprecated */
+export type IdentityProps = {
+    id: string;
+    /**
+     * Type of the identity
+     */
+    flgType: 'primary' | 'persona' | 'IMAP' | 'POP';
+    /**
+     * Localized description of the type of identity
+     */
+    type: string;
+    /**
+     * is a number while you are creating a new one
+     */
+    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;
+};
+type Meta<T extends Record<string, unknown>> = {
+    section?: string;
+    _attrs: T;
+};
+export type Grant = {
+    perm: string;
+    gt: 'usr' | 'grp' | 'dom' | 'cos' | 'all' | 'guest' | 'key' | 'pub';
+    zid: string;
+    expiry?: string;
+    d?: string;
+    pw?: string;
+    key?: string;
+};
+export type SoapPolicy = {
+    type?: 'user' | 'system';
+    id?: string;
+    name?: string;
+    lifetime?: string;
+};
+export type SoapRetentionPolicy = Array<{
+    keep: Array<{
+        policy: SoapPolicy;
+    }>;
+    purge: Array<{
+        policy: SoapPolicy;
+    }>;
+}>;
+export type FolderView = 'search folder' | 'tag' | 'conversation' | 'message' | 'contact' | 'document' | 'appointment' | 'virtual conversation' | 'remote folder' | 'wiki' | 'task' | 'chat';
+export type BaseFolder = {
+    id: string;
+    uuid: string;
+    name: string;
+    absFolderPath?: string;
+    l?: string;
+    luuid?: string;
+    f?: string;
+    color?: number;
+    rgb?: string;
+    u?: number;
+    i4u?: number;
+    view?: FolderView;
+    rev?: number;
+    ms?: number;
+    md?: number;
+    n?: number;
+    i4n?: number;
+    s?: number;
+    i4ms?: number;
+    i4next?: number;
+    url?: string;
+    activesyncdisabled: boolean;
+    webOfflineSyncDays?: number;
+    perm?: string;
+    recursive: boolean;
+    rest?: string;
+    deletable: boolean;
+    meta?: Array<Meta<Record<string, unknown>>>;
+    acl?: {
+        grant: Array<Grant>;
+    };
+    retentionPolicy?: SoapRetentionPolicy;
+    checked?: boolean;
+};
+export type LinkFolderFields = {
+    owner?: string;
+    zid?: string;
+    rid?: string;
+    ruuid?: string;
+    oname?: string;
+    reminder: boolean;
+    broken: boolean;
+};
+export type SearchFolderFields = {
+    query?: string;
+    sortBy?: SortBy;
+    types?: string;
+};
+export type SortBy = 'dateDesc' | 'dateAsc' | 'idDesc' | 'idAsc' | 'subjDesc' | 'subjAsc' | 'nameDesc' | 'nameAsc' | 'durDesc' | 'durAsc' | 'none' | 'taskDueAsc' | 'taskDueDesc' | 'taskStatusAsc' | 'taskStatusDesc' | 'taskPercCompletedAsc' | 'taskPercCompletedDesc' | 'rcptAsc' | 'rcptDesc' | 'readAsc' | 'readDesc';
+export type AccordionFolder = {
+    id: string;
+    label: string;
+    folder: Folder;
+    CustomComponent: ComponentType<{
+        folder: Folder;
+    }>;
+    items: Array<AccordionFolder>;
+};
+export type TreeNode<T> = T & {
+    id: string;
+    children: TreeNode<T>[];
+    parent?: TreeNode<T>;
+};
+export {};

package/lib/types/misc/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/*
+ * SPDX-FileCopyrightText: 2021 Zextras <https://www.zextras.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/misc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/misc/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/lib/types/network/entities.d.ts

@@ -0,0 +1,47 @@
+export type GranteeType = 'usr' | 'grp' | 'egp' | 'all' | 'dom' | 'edom' | 'gst' | 'key' | 'pub' | 'email';
+export type Right = 'invite' | 'loginAs' | 'sendAs' | 'sendOnBehalfOf' | 'viewFreeBusy';
+/** Specify Access Control Entries */
+export interface AccountACEInfo {
+    /** Zimbra ID of the grantee */
+    zid?: string;
+    /**
+     * The type of grantee:
+     *        usr - Zimbra user
+     *    grp - Zimbra group(distribution list)
+     *    all - all authenticated users
+     *    gst - non-Zimbra email address and password (not yet supported)
+     *    key - external user with an accesskey
+     *    pub - public authenticated and unauthenticated access
+     *    If the value is:
+     *        usr - either \{zimbra-id\} or \{grantee-name\} is required
+     * grp - either \{zimbra-id\} or \{grantee-name\} is required
+     * all - \{zimbra-id\}, \{grantee-name\} and \{password\} are ignored
+     * gst - \{zimbra-id\} is ignored, \{grantee-name\} is required, \{password\} is optional
+     * key - \{zimbra-id\} is ignored, \{grantee-name\} is required
+     * pub - \{zimbra-id\}, \{grantee-name\} and \{password\} are ignored
+     * For usr and grp:
+     *    if \{zimbra-id\} is provided, server will lookup the entry by \{zimbra-id\} and
+     * if \{zimbra-id\} is not provided, server will lookup the grantee by \{grantee-type\} and \{grantee-name\}
+     * if the lookup fails, NO_SUCH_ACCOUNT/NO_SUCH_DISTRIBUTION_LIST will be thrown.
+     *    If \{grantee-type\} == key:
+     *    if key is given, server will use that as the access key for this grant
+     * if key is not given, server will generate an access key
+     * If chkgt is "1 (true)", INVALID_REQUEST will be thrown if wrong grantee type is specified.
+     */
+    gt: GranteeType;
+    /** Right */
+    right: Right;
+    /**
+     * Name or email address of the grantee.
+     * Not present if \{grantee-type\} is "all" or "pub"
+     */
+    d?: string;
+    /** Optional access key when \{grantee-type\} is "key" */
+    key?: string;
+    /** Password when \{grantee-type\} is "gst" (not yet supported) */
+    pw?: string;
+    /** "1" if a right is specifically denied or "0" (default) */
+    deny?: boolean;
+    /** "1 (true)" if check grantee type or "0 (false)" (default) */
+    chkgt?: boolean;
+}

package/lib/types/network/entities.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=entities.js.map

package/lib/types/network/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../src/types/network/entities.ts"],"names":[],"mappings":""}