@mattermost/types 11.1.0-0 → 11.1.0-1

package/lib/access_control.d.ts

@@ -0,0 +1,71 @@
+import type { ChannelWithTeamData } from './channels';
+import type { UserProfile } from './users';
+export type AccessControlPolicy = {
+    id: string;
+    name: string;
+    type: string;
+    revision?: number;
+    created_at?: number;
+    version?: string;
+    active?: boolean;
+    imports?: string[];
+    props?: Record<string, unknown[]>;
+    rules: AccessControlPolicyRule[];
+};
+export type AccessControlPolicyCursor = {
+    id: string;
+};
+export type AccessControlPoliciesResult = {
+    policies: AccessControlPolicy[];
+    total: number;
+};
+export type AccessControlPolicySearchOpts = {
+    term: string;
+    type: string;
+    cursor: AccessControlPolicyCursor;
+    limit: number;
+};
+export type AccessControlPolicyChannelsResult = {
+    channels: ChannelWithTeamData[];
+    total: number;
+};
+export type AccessControlPolicyRule = {
+    actions?: string[];
+    expression: string;
+};
+export type CELExpressionError = {
+    message: string;
+    line: number;
+    column: number;
+};
+export type AccessControlTestResult = {
+    users: UserProfile[];
+    total: number;
+};
+export type AccessControlAttribute = {
+    name: string;
+    values: string[];
+};
+export type AccessControlVisualAST = {
+    conditions: AccessControlVisualASTNode[];
+};
+export type AccessControlVisualASTNode = {
+    attribute: string;
+    operator: string;
+    value: any;
+    value_type: number;
+    attribute_type: string;
+};
+/**
+ * Type definition for access control attributes
+ */
+export type AccessControlAttributes = Record<string, string[]>;
+/**
+ * Interface for entities that can have access control
+ */
+export interface AccessControlled {
+    /**
+     * Whether access control is enforced for this entity
+     */
+    access_control_enforced?: boolean;
+}

package/lib/admin.d.ts

@@ -0,0 +1,147 @@
+import type { AccessControlPolicy } from './access_control';
+import type { Audit } from './audits';
+import type { Compliance } from './compliance';
+import type { AdminConfig, ClientLicense, EnvironmentConfig } from './config';
+import type { DataRetentionCustomPolicies } from './data_retention';
+import type { MixedUnlinkedGroupRedux } from './groups';
+import type { PluginRedux, PluginStatusRedux } from './plugins';
+import type { SamlCertificateStatus, SamlMetadataResponse } from './saml';
+import type { Team } from './teams';
+import type { UserAccessToken, UserProfile } from './users';
+import type { RelationOneToOne, IDMappedObjects } from './utilities';
+export declare enum LogLevelEnum {
+    SILLY = "silly",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}
+export type LogServerNames = string[];
+export type LogLevels = LogLevelEnum[];
+export type LogDateFrom = string;
+export type LogDateTo = string;
+export type LogObject = {
+    caller: string;
+    job_id: string;
+    level: LogLevelEnum;
+    msg: string;
+    timestamp: string;
+    worker: string;
+};
+export type LogFilter = {
+    serverNames: LogServerNames;
+    logLevels: LogLevels;
+    dateFrom: LogDateFrom;
+    dateTo: LogDateTo;
+};
+export type LogFilterQuery = {
+    server_names: LogServerNames;
+    log_levels: LogLevels;
+    date_from: LogDateFrom;
+    date_to: LogDateTo;
+};
+export type AdminState = {
+    logs: LogObject[];
+    plainLogs: string[];
+    audits: Record<string, Audit>;
+    config: Partial<AdminConfig>;
+    environmentConfig: Partial<EnvironmentConfig>;
+    complianceReports: Record<string, Compliance>;
+    ldapGroups: Record<string, MixedUnlinkedGroupRedux>;
+    ldapGroupsCount: number;
+    userAccessTokens: Record<string, UserAccessToken>;
+    clusterInfo: ClusterInfo[];
+    samlCertStatus?: SamlCertificateStatus;
+    analytics: AnalyticsState;
+    teamAnalytics: RelationOneToOne<Team, AnalyticsState>;
+    userAccessTokensByUser?: RelationOneToOne<UserProfile, Record<string, UserAccessToken>>;
+    plugins?: Record<string, PluginRedux>;
+    pluginStatuses?: Record<string, PluginStatusRedux>;
+    samlMetadataResponse?: SamlMetadataResponse;
+    dataRetentionCustomPolicies: DataRetentionCustomPolicies;
+    dataRetentionCustomPoliciesCount: number;
+    prevTrialLicense: ClientLicense;
+    accessControlPolicies: IDMappedObjects<AccessControlPolicy>;
+    channelsForAccessControlPolicy: Record<string, string[]>;
+};
+export type AnalyticsState = {
+    POST_PER_DAY?: AnalyticsRow[];
+    BOT_POST_PER_DAY?: AnalyticsRow[];
+    USERS_WITH_POSTS_PER_DAY?: AnalyticsRow[];
+    TOTAL_PUBLIC_CHANNELS?: number;
+    TOTAL_PRIVATE_GROUPS?: number;
+    TOTAL_POSTS?: number;
+    TOTAL_USERS?: number;
+    TOTAL_INACTIVE_USERS?: number;
+    TOTAL_TEAMS?: number;
+    TOTAL_WEBSOCKET_CONNECTIONS?: number;
+    TOTAL_MASTER_DB_CONNECTIONS?: number;
+    TOTAL_READ_DB_CONNECTIONS?: number;
+    DAILY_ACTIVE_USERS?: number;
+    MONTHLY_ACTIVE_USERS?: number;
+    TOTAL_IHOOKS?: number;
+    TOTAL_OHOOKS?: number;
+    TOTAL_COMMANDS?: number;
+    TOTAL_SESSIONS?: number;
+    REGISTERED_USERS?: number;
+    TOTAL_FILE_COUNT?: number;
+    TOTAL_FILE_SIZE?: number;
+};
+export type ClusterInfo = {
+    id: string;
+    version: string;
+    config_hash: string;
+    ipaddress: string;
+    hostname: string;
+    schema_version: string;
+};
+export type AnalyticsRow = {
+    name: string;
+    value: number;
+};
+export type IndexedPluginAnalyticsRow = {
+    [key: string]: PluginAnalyticsRow;
+};
+export declare enum AnalyticsVisualizationType {
+    Count = "count",
+    LineChart = "line_chart",
+    DoughnutChart = "doughnut_chart"
+}
+export type PluginAnalyticsRow = {
+    id: string;
+    name: React.ReactNode;
+    icon?: string;
+    value: any;
+    visualizationType?: AnalyticsVisualizationType;
+};
+export type SchemaMigration = {
+    version: number;
+    name: string;
+};
+export type SupportPacketContent = {
+    id: string;
+    translation_id?: string;
+    label: string;
+    selected: boolean;
+    mandatory: boolean;
+};
+export type LdapSampleEntry = {
+    dn: string;
+    username?: string;
+    email?: string;
+    first_name?: string;
+    last_name?: string;
+    id?: string;
+    display_name?: string;
+    available_attributes?: Record<string, string>;
+};
+export type LdapDiagnosticResult = {
+    test_name: string;
+    test_value: string;
+    total_count: number;
+    entries_with_value: number;
+    message?: string;
+    error?: string;
+    sample_results: LdapSampleEntry[];
+};
+export type TestLdapFiltersResponse = LdapDiagnosticResult[];

package/lib/apps.d.ts

@@ -0,0 +1,191 @@
+import { type ProductScope } from './products';
+export declare enum Permission {
+    UserJoinedChannelNotification = "user_joined_channel_notification",
+    ActAsBot = "act_as_bot",
+    ActAsUser = "act_as_user",
+    PermissionActAsAdmin = "act_as_admin",
+    RemoteOAuth2 = "remote_oauth2",
+    RemoteWebhooks = "remote_webhooks"
+}
+export declare enum Locations {
+    PostMenu = "/post_menu",
+    ChannelHeader = "/channel_header",
+    Command = "/command",
+    InPost = "/in_post"
+}
+export type AppManifest = {
+    app_id: string;
+    version?: string;
+    homepage_url?: string;
+    icon?: string;
+    display_name: string;
+    description?: string;
+    requested_permissions?: Permission[];
+    requested_locations?: Locations[];
+};
+export type AppModalState = {
+    form: AppForm;
+    call: AppCallRequest;
+};
+export type AppCommandFormMap = {
+    [location: string]: AppForm;
+};
+export type BindingsInfo = {
+    bindings: AppBinding[];
+    forms: AppCommandFormMap;
+};
+export type AppsState = {
+    main: BindingsInfo;
+    rhs: BindingsInfo;
+    pluginEnabled: boolean;
+};
+export type AppBinding = {
+    app_id: string;
+    location?: string;
+    supported_product_ids?: ProductScope;
+    icon?: string;
+    label: string;
+    hint?: string;
+    description?: string;
+    role_id?: string;
+    depends_on_team?: boolean;
+    depends_on_channel?: boolean;
+    depends_on_user?: boolean;
+    depends_on_post?: boolean;
+    bindings?: AppBinding[];
+    form?: AppForm;
+    submit?: AppCall;
+};
+export declare function isAppBinding(obj: unknown): obj is AppBinding;
+export type AppCallValues = {
+    [name: string]: any;
+};
+export type AppCall = {
+    path: string;
+    expand?: AppExpand;
+    state?: any;
+};
+export type AppCallRequest = AppCall & {
+    context: AppContext;
+    values?: AppCallValues;
+    raw_command?: string;
+    selected_field?: string;
+    query?: string;
+};
+export type AppCallResponseType = string;
+export type AppCallResponse<Res = unknown> = {
+    type: AppCallResponseType;
+    text?: string;
+    data?: Res;
+    navigate_to_url?: string;
+    use_external_browser?: boolean;
+    call?: AppCall;
+    form?: AppForm;
+    app_metadata?: AppMetadataForClient;
+};
+export type AppMetadataForClient = {
+    bot_user_id: string;
+    bot_username: string;
+};
+export type AppContext = {
+    app_id: string;
+    location?: string;
+    acting_user_id?: string;
+    user_id?: string;
+    channel_id?: string;
+    team_id?: string;
+    post_id?: string;
+    root_id?: string;
+    props?: AppContextProps;
+    user_agent?: string;
+    track_as_submit?: boolean;
+};
+export type AppContextProps = {
+    [name: string]: string;
+};
+export type AppExpandLevel = '' | 'none' | 'summary' | '+summary' | 'all' | '+all' | 'id';
+export type AppExpand = {
+    app?: AppExpandLevel;
+    acting_user?: AppExpandLevel;
+    acting_user_access_token?: AppExpandLevel;
+    channel?: AppExpandLevel;
+    config?: AppExpandLevel;
+    mentioned?: AppExpandLevel;
+    parent_post?: AppExpandLevel;
+    post?: AppExpandLevel;
+    root_post?: AppExpandLevel;
+    team?: AppExpandLevel;
+    user?: AppExpandLevel;
+    locale?: AppExpandLevel;
+};
+export type AppForm = {
+    title?: string;
+    header?: string;
+    footer?: string;
+    icon?: string;
+    submit_label?: string;
+    submit_buttons?: string;
+    cancel_button?: boolean;
+    submit_on_cancel?: boolean;
+    fields?: AppField[];
+    source?: AppCall;
+    submit?: AppCall;
+    depends_on?: string[];
+};
+export type AppFormValue = string | AppSelectOption | AppSelectOption[] | boolean | null;
+export type AppFormValues = {
+    [name: string]: AppFormValue;
+};
+export type AppSelectOption = {
+    label: string;
+    value: string;
+    icon_data?: string;
+};
+export type AppFieldType = string;
+export type AppField = {
+    name: string;
+    type: AppFieldType;
+    is_required?: boolean;
+    readonly?: boolean;
+    value?: AppFormValue;
+    description?: string;
+    label?: string;
+    hint?: string;
+    position?: number;
+    modal_label?: string;
+    refresh?: boolean;
+    options?: AppSelectOption[];
+    multiselect?: boolean;
+    lookup?: AppCall;
+    subtype?: string;
+    min_length?: number;
+    max_length?: number;
+    min_date?: string;
+    max_date?: string;
+    time_interval?: number;
+};
+export type AutocompleteSuggestion = {
+    suggestion: string;
+    complete?: string;
+    description?: string;
+    hint?: string;
+    iconData?: string;
+};
+export type AutocompleteSuggestionWithComplete = AutocompleteSuggestion & {
+    complete: string;
+};
+export type AutocompleteElement = AppField;
+export type AutocompleteStaticSelect = AutocompleteElement & {
+    options: AppSelectOption[];
+};
+export type AutocompleteDynamicSelect = AutocompleteElement;
+export type AutocompleteUserSelect = AutocompleteElement;
+export type AutocompleteChannelSelect = AutocompleteElement;
+export type FormResponseData = {
+    errors?: {
+        [field: string]: string;
+    };
+};
+export type AppLookupResponse = {
+    items: AppSelectOption[];
+};

package/lib/audits.d.ts

@@ -0,0 +1,9 @@
+export type Audit = {
+    id: string;
+    create_at: number;
+    user_id: string;
+    action: string;
+    extra_info: string;
+    ip_address: string;
+    session_id: string;
+};

package/lib/autocomplete.d.ts

@@ -0,0 +1,12 @@
+import type { UserProfile } from './users';
+export type UserAutocomplete = {
+    users: UserProfile[];
+    out_of_channel?: UserProfile[];
+};
+export type AutocompleteSuggestion = {
+    Complete: string;
+    Suggestion: string;
+    Hint: string;
+    Description: string;
+    IconData: string;
+};

package/lib/bots.d.ts

@@ -0,0 +1,15 @@
+export type Bot = {
+    user_id: string;
+    username: string;
+    display_name?: string;
+    description?: string;
+    owner_id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+};
+export type BotPatch = {
+    username: string;
+    display_name: string;
+    description: string;
+};

package/lib/channel_bookmarks.d.ts

@@ -0,0 +1,51 @@
+import type { Channel } from './channels';
+import type { FileInfo } from './files';
+import type { IDMappedObjects } from './utilities';
+type ChannelBookmarkType = 'link' | 'file';
+export type ChannelBookmark = {
+    id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    channel_id: string;
+    owner_id: string;
+    file_id?: string;
+    file?: FileInfo;
+    display_name: string;
+    sort_order: number;
+    link_url?: string;
+    image_url?: string;
+    emoji?: string;
+    type: ChannelBookmarkType;
+    original_id?: string;
+    parent_id?: string;
+};
+export type ChannelBookmarkCreate = {
+    display_name: string;
+    image_url?: string;
+    emoji?: string;
+    type: ChannelBookmarkType;
+} & ({
+    type: 'link';
+    link_url: string;
+} | {
+    type: 'file';
+    file_id: string;
+});
+export type ChannelBookmarkPatch = {
+    file_id?: string;
+    display_name?: string;
+    sort_order?: number;
+    link_url?: string;
+    image_url?: string;
+    emoji?: string;
+};
+export type ChannelBookmarkWithFileInfo = ChannelBookmark & {
+    file: FileInfo;
+};
+export type ChannelBookmarksState = {
+    byChannelId: {
+        [channelId: Channel['id']]: IDMappedObjects<ChannelBookmark>;
+    };
+};
+export {};

package/lib/channel_categories.d.ts

@@ -0,0 +1,30 @@
+import type { Channel } from './channels';
+import type { Team } from './teams';
+import type { UserProfile } from './users';
+import type { IDMappedObjects, RelationOneToOne } from './utilities';
+export type ChannelCategoryType = 'favorites' | 'channels' | 'direct_messages' | 'custom';
+export declare enum CategorySorting {
+    Alphabetical = "alpha",
+    Default = "",// behaves the same as manual
+    Recency = "recent",
+    Manual = "manual"
+}
+export type ChannelCategory = {
+    id: string;
+    user_id: UserProfile['id'];
+    team_id: Team['id'];
+    type: ChannelCategoryType;
+    display_name: string;
+    sorting: CategorySorting;
+    channel_ids: Array<Channel['id']>;
+    muted: boolean;
+    collapsed: boolean;
+};
+export type OrderedChannelCategories = {
+    categories: ChannelCategory[];
+    order: string[];
+};
+export type ChannelCategoriesState = {
+    byId: IDMappedObjects<ChannelCategory>;
+    orderByTeam: RelationOneToOne<Team, Array<ChannelCategory['id']>>;
+};