@mattermost/types 11.1.0-0 → 11.1.0-1

package/lib/channels.d.ts

@@ -0,0 +1,190 @@
+import type { Team } from './teams';
+import type { IDMappedObjects, RelationOneToManyUnique, RelationOneToOne } from './utilities';
+export type ChannelType = 'O' | 'P' | 'D' | 'G' | 'threads';
+export type ChannelStats = {
+    channel_id: string;
+    member_count: number;
+    guest_count: number;
+    pinnedpost_count: number;
+    files_count: number;
+};
+export type ChannelNotifyProps = {
+    desktop_threads: 'default' | 'all' | 'mention' | 'none';
+    desktop: 'default' | 'all' | 'mention' | 'none';
+    desktop_sound: 'default' | 'on' | 'off';
+    desktop_notification_sound?: 'default' | 'Bing' | 'Crackle' | 'Down' | 'Hello' | 'Ripple' | 'Upstairs';
+    email: 'default' | 'all' | 'mention' | 'none';
+    mark_unread: 'all' | 'mention';
+    push: 'default' | 'all' | 'mention' | 'none';
+    push_threads: 'default' | 'all' | 'mention' | 'none';
+    ignore_channel_mentions: 'default' | 'off' | 'on';
+    channel_auto_follow_threads: 'off' | 'on';
+};
+export type ChannelBanner = {
+    enabled?: boolean;
+    text?: string;
+    background_color?: string;
+};
+export declare function channelBannerEnabled(banner: ChannelBanner | undefined): boolean;
+export type Channel = {
+    id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    team_id: string;
+    type: ChannelType;
+    display_name: string;
+    name: string;
+    header: string;
+    purpose: string;
+    last_post_at: number;
+    last_root_post_at: number;
+    creator_id: string;
+    scheme_id: string;
+    teammate_id?: string;
+    status?: string;
+    group_constrained: boolean;
+    shared?: boolean;
+    props?: Record<string, any>;
+    policy_id?: string | null;
+    banner_info?: ChannelBanner;
+    policy_enforced?: boolean;
+    default_category_name?: string;
+};
+export type ServerChannel = Channel & {
+    /**
+     * The total number of posts in this channel, not including join/leave messages
+     *
+     * @remarks This field will be moved to a {@link ChannelMessageCount} object when this channel is stored in Redux.
+     */
+    total_msg_count: number;
+    /**
+     * The number of root posts in this channel, not including join/leave messages
+     *
+     * @remarks This field will be moved to a {@link ChannelMessageCount} object when this channel is stored in Redux.
+     */
+    total_msg_count_root: number;
+};
+export type ChannelMessageCount = {
+    /** The total number of posts in this channel, not including join/leave messages */
+    total: number;
+    /** The number of root posts in this channel, not including join/leave messages */
+    root: number;
+};
+export type ChannelWithTeamData = Channel & {
+    team_display_name: string;
+    team_name: string;
+    team_update_at: number;
+};
+export type ChannelsWithTotalCount = {
+    channels: ChannelWithTeamData[];
+    total_count: number;
+};
+export type ChannelMembership = {
+    channel_id: string;
+    user_id: string;
+    roles: string;
+    last_viewed_at: number;
+    /** The number of posts in this channel which have been read by the user */
+    msg_count: number;
+    /** The number of root posts in this channel which have been read by the user */
+    msg_count_root: number;
+    /** The number of unread mentions in this channel */
+    mention_count: number;
+    /** The number of unread mentions in root posts in this channel */
+    mention_count_root: number;
+    /** The number of unread urgent mentions in this channel */
+    urgent_mention_count: number;
+    notify_props: Partial<ChannelNotifyProps>;
+    last_update_at: number;
+    scheme_user: boolean;
+    scheme_admin: boolean;
+    post_root_id?: string;
+};
+export type ChannelUnread = {
+    channel_id: string;
+    user_id: string;
+    team_id: string;
+    /** The number of posts which have been read by the user */
+    msg_count: number;
+    /** The number of root posts which have been read by the user */
+    msg_count_root: number;
+    /** The number of unread mentions in this channel */
+    mention_count: number;
+    /** The number of unread urgent mentions in this channel */
+    urgent_mention_count: number;
+    /** The number of unread mentions in root posts in this channel */
+    mention_count_root: number;
+    last_viewed_at: number;
+    deltaMsgs: number;
+};
+export type ChannelsState = {
+    currentChannelId: string;
+    channels: IDMappedObjects<Channel>;
+    channelsInTeam: RelationOneToManyUnique<Team, Channel>;
+    myMembers: RelationOneToOne<Channel, ChannelMembership>;
+    roles: RelationOneToOne<Channel, Set<string>>;
+    membersInChannel: RelationOneToOne<Channel, Record<string, ChannelMembership>>;
+    stats: RelationOneToOne<Channel, ChannelStats>;
+    groupsAssociatedToChannel: any;
+    totalCount: number;
+    manuallyUnread: RelationOneToOne<Channel, boolean>;
+    channelModerations: RelationOneToOne<Channel, ChannelModeration[]>;
+    channelMemberCountsByGroup: RelationOneToOne<Channel, ChannelMemberCountsByGroup>;
+    messageCounts: RelationOneToOne<Channel, ChannelMessageCount>;
+    channelsMemberCount: Record<string, number>;
+    restrictedDMs: RelationOneToOne<Channel, boolean>;
+};
+export type ChannelModeration = {
+    name: string;
+    roles: {
+        guests?: {
+            value: boolean;
+            enabled: boolean;
+        };
+        members: {
+            value: boolean;
+            enabled: boolean;
+        };
+        admins: {
+            value: boolean;
+            enabled: boolean;
+        };
+    };
+};
+export type ChannelModerationPatch = {
+    name: string;
+    roles: {
+        guests?: boolean;
+        members?: boolean;
+    };
+};
+export type ChannelMemberCountByGroup = {
+    group_id: string;
+    channel_member_count: number;
+    channel_member_timezones_count: number;
+};
+export type ChannelMemberCountsByGroup = Record<string, ChannelMemberCountByGroup>;
+export type ChannelViewResponse = {
+    status: string;
+    last_viewed_at_times: RelationOneToOne<Channel, number>;
+};
+export type ChannelSearchOpts = {
+    nonAdminSearch?: boolean;
+    exclude_default_channels?: boolean;
+    not_associated_to_group?: string;
+    team_ids?: string[];
+    group_constrained?: boolean;
+    exclude_group_constrained?: boolean;
+    public?: boolean;
+    private?: boolean;
+    include_deleted?: boolean;
+    include_search_by_id?: boolean;
+    exclude_remote?: boolean;
+    deleted?: boolean;
+    page?: number;
+    per_page?: number;
+    access_control_policy_enforced?: boolean;
+    exclude_access_control_policy_enforced?: boolean;
+    parent_access_control_policy_id?: string;
+};

package/lib/client4.d.ts

@@ -0,0 +1,42 @@
+export declare enum LogLevel {
+    Error = "ERROR",
+    Warning = "WARNING",
+    Info = "INFO",
+    Debug = "DEBUG"
+}
+export type ClientResponse<T> = {
+    response: Response;
+    headers: Map<string, string>;
+    data: T;
+};
+export type Options = {
+    headers?: {
+        [x: string]: string;
+    };
+    method?: string;
+    url?: string;
+    credentials?: 'omit' | 'same-origin' | 'include';
+    body?: any;
+    signal?: RequestInit['signal'];
+    ignoreStatus?: boolean; /** If true, status codes > 300 are ignored and don't cause an error */
+    duplex?: 'half'; /** Optional, but required for node clients. Must be 'half' for half-duplex fetch; 'full' is reserved for future use. See https://fetch.spec.whatwg.org/#dom-requestinit-duplex */
+};
+export type OptsSignalExt = {
+    signal?: AbortSignal;
+};
+export type StatusOK = {
+    status: 'OK';
+};
+export declare const isStatusOK: (x: StatusOK | Record<string, unknown>) => x is StatusOK;
+export type FetchPaginatedThreadOptions = {
+    fetchThreads?: boolean;
+    collapsedThreads?: boolean;
+    collapsedThreadsExtended?: boolean;
+    updatesOnly?: boolean;
+    direction?: 'up' | 'down';
+    fetchAll?: boolean;
+    perPage?: number;
+    fromCreateAt?: number;
+    fromUpdateAt?: number;
+    fromPost?: string;
+};

package/lib/cloud.d.ts

@@ -0,0 +1,187 @@
+import type { AllowedIPRange } from './config';
+export type CloudState = {
+    subscription?: Subscription;
+    products?: Record<string, Product>;
+    customer?: CloudCustomer;
+    invoices?: Record<string, Invoice>;
+    limits: {
+        limitsLoaded: boolean;
+        limits: Limits;
+    };
+    errors: {
+        subscription?: true;
+        products?: true;
+        customer?: true;
+        invoices?: true;
+        limits?: true;
+        trueUpReview?: true;
+    };
+};
+export type Installation = {
+    id: string;
+    state: string;
+    allowed_ip_ranges: AllowedIPRange[];
+};
+export type Subscription = {
+    id: string;
+    customer_id: string;
+    product_id: string;
+    add_ons: string[];
+    start_at: number;
+    end_at: number;
+    create_at: number;
+    seats: number;
+    last_invoice?: Invoice;
+    upcoming_invoice?: Invoice;
+    trial_end_at: number;
+    is_free_trial: string;
+    delinquent_since?: number;
+    compliance_blocked?: string;
+    billing_type?: string;
+    cancel_at?: number;
+    will_renew?: string;
+    simulated_current_time_ms?: number;
+    is_cloud_preview?: boolean;
+};
+export type Product = {
+    id: string;
+    name: string;
+    description: string;
+    price_per_seat: number;
+    add_ons: AddOn[];
+    product_family: string;
+    sku: string;
+    billing_scheme: string;
+    recurring_interval: string;
+    cross_sells_to: string;
+};
+export type AddOn = {
+    id: string;
+    name: string;
+    display_name: string;
+    price_per_seat: number;
+};
+export type CloudCustomer = {
+    id: string;
+    creator_id: string;
+    create_at: number;
+    email: string;
+    name: string;
+    num_employees: number;
+    contact_first_name: string;
+    contact_last_name: string;
+    billing_address: Address;
+    company_address: Address;
+    payment_method: PaymentMethod;
+};
+export type CloudCustomerPatch = {
+    email?: string;
+    name?: string;
+    num_employees?: number;
+    contact_first_name?: string;
+    contact_last_name?: string;
+};
+export type Address = {
+    city: string;
+    country: string;
+    line1: string;
+    line2: string;
+    postal_code: string;
+    state: string;
+};
+export type PaymentMethod = {
+    type: string;
+    last_four: string;
+    exp_month: number;
+    exp_year: number;
+    card_brand: string;
+    name: string;
+};
+export type NotifyAdminRequest = {
+    trial_notification: boolean;
+    required_plan: string;
+    required_feature: string;
+};
+export type Invoice = {
+    id: string;
+    number: string;
+    create_at: number;
+    total: number;
+    tax: number;
+    status: string;
+    description: string;
+    period_start: number;
+    period_end: number;
+    subscription_id: string;
+    line_items: InvoiceLineItem[];
+    current_product_name: string;
+};
+export declare const InvoiceLineItemType: {
+    readonly Full: "full";
+    readonly Partial: "partial";
+    readonly OnPremise: "onpremise";
+    readonly Metered: "metered";
+};
+export type InvoiceLineItem = {
+    price_id: string;
+    total: number;
+    quantity: number;
+    price_per_unit: number;
+    description: string;
+    type: typeof InvoiceLineItemType[keyof typeof InvoiceLineItemType];
+    metadata: Record<string, string>;
+    period_start: number;
+    period_end: number;
+};
+export type Limits = {
+    messages?: {
+        history?: number;
+    };
+    files?: {
+        total_storage?: number;
+    };
+    teams?: {
+        active?: number;
+    };
+};
+export interface CloudUsage {
+    files: {
+        totalStorage: number;
+        totalStorageLoaded: boolean;
+    };
+    messages: {
+        history: number;
+        historyLoaded: boolean;
+    };
+    teams: TeamsUsage;
+}
+export type TeamsUsage = {
+    active: number;
+    cloudArchived: number;
+    teamsLoaded: boolean;
+};
+export type ValidBusinessEmail = {
+    is_valid: boolean;
+};
+export interface NewsletterRequestBody {
+    email: string;
+    subscribed_content: string;
+}
+export declare const areShippingDetailsValid: (address: Address | null | undefined) => boolean;
+export type Feedback = {
+    reason: string;
+    comments: string;
+};
+export type MessageDescriptor = {
+    id: string;
+    defaultMessage: string;
+    values?: Record<string, any>;
+};
+export type PreviewModalContentData = {
+    skuLabel: MessageDescriptor;
+    title: MessageDescriptor;
+    subtitle: MessageDescriptor;
+    videoUrl: string;
+    videoPoster?: string;
+    useCase: string;
+};

package/lib/compliance.d.ts

@@ -0,0 +1,13 @@
+export type Compliance = {
+    id: string;
+    create_at: number;
+    user_id: string;
+    status: string;
+    count: number;
+    desc: string;
+    type: string;
+    start_at: number;
+    end_at: number;
+    keywords: string;
+    emails: string;
+};