@atlaskit/mention 26.2.0 → 27.0.0

package/dist/types-ts4.5/types.d.ts

@@ -1,320 +0,0 @@
-import { type SyntheticEvent } from 'react';
-import { type ServiceConfig } from '@atlaskit/util-service-support/types';
-export interface MentionNameResolver {
-    cacheName(id: string, name: string): void;
-    lookupName(id: string): Promise<MentionNameDetails> | MentionNameDetails;
-}
-export type MentionStats = {
-    [key: string]: any;
-};
-export interface ResultCallback<T> {
-    (result: T, query?: string, stats?: MentionStats): void;
-}
-export interface ErrorCallback {
-    (error: Error, query?: string): void;
-}
-export interface InfoCallback {
-    (info: string): void;
-}
-export interface AnalyticsCallback {
-    (event: string, actionSubject: string, action: string, attributes?: {
-        [key: string]: any;
-    }): void;
-}
-/**
- * Configuration for the MentionResource, which provides a JavaScript API
- * for fetching and searching user mentions from a remote service.
- *
- * Extends {@link ServiceConfig} which provides the base `url`, `securityProvider`,
- * and `refreshedSecurityProvider` fields.
- */
-export interface MentionResourceConfig extends ServiceConfig {
-    /**
-     * The ID of the container (e.g. a Confluence space or Jira project) used to scope
-     * mention search results. Can be overridden by `MentionContextIdentifier.containerId`.
-     */
-    containerId?: string;
-    /**
-     * Debounce time in milliseconds for the `filter` method. When set, rapid successive
-     * calls to `filter` will be debounced to reduce the number of network requests.
-     */
-    debounceTime?: number;
-    /**
-     * A function to determine whether a given mention should be rendered in
-     * its disabled visual state (`MentionType.DISABLED`), and what tooltip
-     * (if any) to display when the disabled chip is hovered.
-     *
-     * Returning `{ disabled: false }` (or `undefined`) leaves the mention in
-     * whatever state the other predicates resolve to.
-     *
-     * The input deliberately exposes only the mention's `id` because the
-     * canonical caller (the editor mentions `NodeView`) does not have the
-     * full `MentionDescription` in scope. Implementations should look the
-     * additional context they need (e.g. agent metadata) up via the `id`.
-     *
-     * @param mention - The minimal mention identifier to evaluate.
-     * @returns `{ disabled, tooltip? }` describing the disabled visual state,
-     * or `undefined` to leave it unchanged.
-     */
-    getMentionDisabledState?: (mention: MentionDisabledStateInput) => MentionDisabledState | undefined;
-    /**
-     * Custom HTTP headers to include in mention service requests.
-     */
-    headers?: Record<string, string>;
-    /**
-     * Callback to invite a cross-product user. Invoked when a user from another
-     * Atlassian product is selected for mention and needs to be invited.
-     *
-     * @param userId - The ID of the user to invite.
-     * @param mentionName - The display name of the user being invited.
-     * @returns A promise that resolves when the invitation is complete.
-     */
-    inviteXProductUser?: (userId: string, mentionName: string) => Promise<void>;
-    /**
-     * A resolver for looking up and caching mention display names by user ID.
-     * Used by `ResolvingMentionProvider` to resolve names for mentions that
-     * only have an ID (e.g. when rendering stored mention nodes).
-     */
-    mentionNameResolver?: MentionNameResolver;
-    /**
-     * Callback invoked when the inline invite item is clicked in the mention picker.
-     *
-     * @param flow - The type of invite flow, either `'mention'` or `'assign'`.
-     */
-    onInviteItemClick?: (flow: InviteFlow) => void;
-    /**
-     * The product identifier (e.g. `'confluence'`, `'jira'`) sent as a query parameter
-     * (`productIdentifier`) to the mention service for product-scoped results.
-     */
-    productId?: string;
-    /**
-     * The display name of the product, exposed on the `MentionProvider` for use
-     * by invite-related UI components.
-     */
-    productName?: string;
-    /**
-     * Whether to enable the inline invite functionality in the mention picker,
-     * allowing users to invite people who are not yet part of the site.
-     */
-    shouldEnableInvite?: boolean;
-    /**
-     * A function to determine whether a given mention should be visually highlighted
-     * (e.g. as a self-mention). When provided, it is called for each mention to decide
-     * if the `MentionType.SELF` styling should be applied.
-     *
-     * @param mention - The mention to evaluate.
-     * @returns `true` if the mention should be highlighted.
-     */
-    shouldHighlightMention?: (mention: MentionDescription) => boolean;
-    /**
-     * The role of the current user, used to determine invite permissions
-     * in the mention picker. Defaults to `'basic'` if not provided.
-     */
-    userRole?: UserRole;
-}
-/**
- * Describes whether a mention should be rendered in its disabled visual
- * state and what tooltip (if any) should be shown on hover.
- */
-export interface MentionDisabledState {
-    disabled: boolean;
-    tooltip?: string;
-}
-/**
- * The minimal input shape used by `getMentionDisabledState`. Kept as a named
- * type so the config callback and the provider method share the same input
- * surface, and so callers do not have to fabricate fields they do not have.
- */
-export interface MentionDisabledStateInput {
-    id: string;
-}
-export interface ResourceProvider<Result> {
-    /**
-     * Subscribe to ResourceProvider results
-     *
-     * @param {string} key subscriber key used to unsubscribe
-     * @param {ResultCallback<Result>} callback This callback only receives latest results
-     * @param {ErrorCallback} errCallback This callback will errors
-     * @param {InfoCallback} infoCallback This callback will info
-     * @param {ResultCallback<Result>} allResultsCallback This callback will receive all results
-     */
-    subscribe(key: string, callback?: ResultCallback<Result>, errCallback?: ErrorCallback, infoCallback?: InfoCallback, allResultsCallback?: ResultCallback<Result>, analyticsCallback?: AnalyticsCallback): void;
-    /**
-     * Unsubscribe to this resource provider results
-     * @param {string} key key used when subscribing
-     */
-    unsubscribe(key: string): void;
-}
-export type MentionContextIdentifier = {
-    childObjectId?: string;
-    containerId?: string;
-    objectId?: string;
-    sessionId?: string;
-};
-export interface MentionProvider extends ResourceProvider<MentionDescription[]>, InviteFromMentionProvider, XProductInviteMentionProvider {
-    filter(query?: string, contextIdentifier?: MentionContextIdentifier): void;
-    /**
-     * Optional. When implemented, lets the rendering surface ask whether a
-     * mention should be displayed in its disabled visual state, and what
-     * tooltip to surface on hover. Returning `undefined` (or omitting the
-     * method entirely) is equivalent to "not disabled".
-     */
-    getMentionDisabledState?(mention: MentionDisabledStateInput): MentionDisabledState | undefined;
-    isFiltering(query: string): boolean;
-    /**
-     * Optional. Called by the rendering surface (e.g. the editor NodeView)
-     * when a mention chip is destroyed (removed from the doc). This is the
-     * lowest-level deletion signal — it fires regardless of how the chip was
-     * removed (backspace, select-and-delete, programmatic replace, …) and
-     * does not depend on the editor's debounced `onChange` callback.
-     *
-     * Implementations typically forward the call to consumers via the chat
-     * layer so they can react (e.g. update `selectedAgentIds`).
-     */
-    notifyMentionDestroyed?(mention: {
-        id: string;
-    }): void;
-    recordMentionSelection(mention: MentionDescription, contextIdentifier?: MentionContextIdentifier): void;
-    shouldHighlightMention(mention: MentionDescription): boolean;
-    /**
-     * Optional. When implemented, lets the rendering surface subscribe to
-     * changes in the disabled-state predicate so already-rendered chips can
-     * re-evaluate themselves when the external state that drives
-     * `getMentionDisabledState` changes (e.g. the active agent selection in
-     * Rovo Chat). Implementations should invoke the listener after their
-     * own state changes.
-     *
-     * Returns an unsubscribe function. Callers MUST invoke it on teardown.
-     */
-    subscribeToDisabledStateChanges?(listener: () => void): () => void;
-}
-export interface HighlightDetail {
-    end: number;
-    start: number;
-}
-export interface Highlight {
-    mentionName: HighlightDetail[];
-    name: HighlightDetail[];
-    nickname: HighlightDetail[];
-}
-export interface Presence {
-    status?: string;
-    time?: string;
-}
-export type LozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'new' | 'moved';
-export interface LozengeProps {
-    appearance?: LozengeColor;
-    text: React.ReactNode;
-}
-export interface MentionDescription {
-    accessLevel?: string;
-    appType?: string | null;
-    avatarUrl?: string;
-    context?: MentionDescContext;
-    highlight?: Highlight;
-    id: string;
-    inContext?: boolean;
-    isXProductUser?: boolean;
-    lozenge?: string | LozengeProps;
-    mentionName?: string;
-    name?: string;
-    nickname?: string;
-    presence?: Presence;
-    source?: string;
-    userType?: string;
-}
-export interface MentionDescContext {
-    includesYou: boolean;
-    memberCount: number;
-    members: TeamMember[];
-    teamLink: string;
-}
-export interface MentionsResult {
-    mentions: MentionDescription[];
-    query: string;
-}
-export interface TeamMember {
-    id: string;
-    name: string;
-}
-export interface Team {
-    displayName: string;
-    highlight?: Highlight;
-    id: string;
-    includesYou: boolean;
-    memberCount: number;
-    members: TeamMember[];
-    smallAvatarImageUrl: string;
-}
-export type MentionEventHandler = (mentionId: string, text: string, event?: SyntheticEvent<HTMLSpanElement>) => void;
-export interface OnMentionEvent {
-    (mention: MentionDescription, event?: SyntheticEvent<any>): void;
-}
-export declare enum MentionType {
-    SELF = 0,
-    RESTRICTED = 1,
-    DEFAULT = 2,
-    DISABLED = 3
-}
-export declare enum UserAccessLevel {
-    NONE = 0,
-    SITE = 1,
-    APPLICATION = 2,
-    CONTAINER = 3
-}
-export declare enum UserType {
-    DEFAULT = 0,
-    SPECIAL = 1,
-    APP = 2,
-    TEAM = 3,
-    SYSTEM = 4
-}
-export declare enum SliNames {
-    SEARCH = "searchUser",
-    SEARCH_TEAM = "searchTeam",
-    INITIAL_STATE = "initialState",
-    SELECT = "select",
-    SELECT_TEAM = "selectTeam"
-}
-export declare enum ComponentNames {
-    TYPEAHEAD = "mentionTypeahead",
-    MENTION = "mention"
-}
-export declare enum Actions {
-    VIEWED = "viewed",
-    CLICKED = "clicked",
-    CLOSED = "closed",
-    SUCCEEDED = "succeeded",
-    FAILED = "failed"
-}
-export declare enum MentionNameStatus {
-    UNKNOWN = 0,
-    SERVICE_ERROR = 1,
-    OK = 2
-}
-export interface MentionNameDetails {
-    id: string;
-    name?: string;
-    status: MentionNameStatus;
-}
-export declare function isRestricted(accessLevel?: string): boolean;
-export declare function isSpecialMention(mention: MentionDescription): boolean;
-export declare function isAppMention(mention: MentionDescription): boolean | '' | undefined;
-export declare function isTeamMention(mention: MentionDescription): boolean | '' | undefined;
-export declare function isSpecialMentionText(mentionText: string): boolean | '';
-export declare const isPromise: <T>(p: any) => p is Promise<T>;
-export type InviteFlow = 'mention' | 'assign';
-export type UserRole = 'admin' | 'trusted' | 'basic';
-export interface InviteFromMentionProvider {
-    getShouldEnableInlineInvite?: () => boolean;
-    InlineInviteRecaptcha?: React.ComponentType<any> | null;
-    onInviteItemClick?(flow: InviteFlow): void;
-    productName?: string;
-    shouldEnableInvite?: boolean;
-    showInlineInviteRecaptcha?: (email: string) => void;
-    userEmailDomain?: string;
-    userRole?: UserRole;
-}
-export interface XProductInviteMentionProvider {
-    inviteXProductUser?: (userId: string, mentionName: string) => Promise<void>;
-}

package/dist/types-ts4.5/util/analytics.d.ts

@@ -1,12 +0,0 @@
-import { type UIAnalyticsEvent, type WithAnalyticsEventsProps, type CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { type GasPayload } from '@atlaskit/analytics-gas-types';
-export declare const SLI_EVENT_TYPE = "sli";
-export declare const SMART_EVENT_TYPE = "smart";
-export declare const fireAnalyticsMentionTypeaheadEvent: (props: WithAnalyticsEventsProps) => (action: string, duration: number, userIds?: string[], query?: string) => void;
-export declare const fireAnalyticsMentionEvent: (createEvent: CreateUIAnalyticsEvent) => (actionSubject: string, action: string, text: string, id: string, accessLevel?: string) => UIAnalyticsEvent;
-export declare const fireSliAnalyticsEvent: (props: WithAnalyticsEventsProps) => (actionSubject: string, action: string) => void;
-export declare const buildSliPayload: (actionSubject: string, action: string, attributes?: {
-    [key: string]: any;
-}) => GasPayload;
-export declare const fireAnalyticsMentionHydrationEvent: (props: WithAnalyticsEventsProps) => (action: string, userId: string, fromCache: boolean, duration: number) => void;
-export declare const fireAnalytics: (firePrivateAnalyticsEvent?: Function) => (eventName: string, text: string, accessLevel?: string) => void;

package/dist/types-ts4.5/util/atl-attribution.d.ts

@@ -1,8 +0,0 @@
-export interface AtlAttributionConfig {
-    activationId?: string;
-    cloudId: string;
-    productId?: string;
-}
-export declare function buildAtlAttributionHeaderValue(config: AtlAttributionConfig): {
-    'atl-attribution': string;
-} | undefined;

package/dist/types-ts4.5/util/i18n.d.ts

@@ -1,29 +0,0 @@
-import React from 'react';
-import { type MessageDescriptor } from 'react-intl';
-export type Formatter = (props: {
-    children?(props: string): React.ReactElement;
-    values?: {
-        [k: string]: string;
-    };
-}) => React.ReactElement | null;
-type FormatterFactory = (messageDescriptor: MessageDescriptor) => Formatter;
-export declare const propFormatter: FormatterFactory;
-export declare const UnknownUserError: Formatter;
-export declare const NoAccessWarning: Formatter;
-export declare const NoAccessLabel: Formatter;
-export declare const DefaultHeadline: Formatter;
-export declare const DefaultAdvisedAction: Formatter;
-export declare const LoginAgain: Formatter;
-export declare const DifferentText: Formatter;
-/**
- * Tries to get the most specific messages bundle for a given locale.
- *
- * Strategy:
- * 1. Try to find messages with the exact string (i.e. 'fr_FR')
- * 2. If that doesn't work, try to find messages for the country locale (i.e. 'fr')
- * 3. If that doesn't work, return english messages as a fallback.
- *
- * @param locale string specifying the locale like 'en_GB', or 'fr'.
- */
-export declare const getMessagesForLocale: (locale: string) => Promise<Record<string, string>>;
-export {};

package/dist/types-ts4.5/util/id.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (prefix?: string) => string;
-export default _default;

package/dist/types-ts4.5/util/index.d.ts

@@ -1 +0,0 @@
-export declare const padArray: (arr: any[], size: number, value: any) => any[];

package/dist/types-ts4.5/util/logger.d.ts

@@ -1,4 +0,0 @@
-export declare function enableLogger(enable: boolean): void;
-export declare function enableStacktraces(enable: boolean): void;
-export declare function logStacktrace(): void;
-export default function debug(msg: any, ...args: any[]): void;

package/dist/types-ts4.5/util/mouse.d.ts

@@ -1,8 +0,0 @@
-import { type MouseEvent } from 'react';
-export interface Position {
-    x: number;
-    y: number;
-}
-export declare function mouseLocation(event: MouseEvent<any>): Position;
-export declare function actualMouseMove(oldPosition: Position | undefined, newPosition: Position): boolean;
-export declare function leftClick(event: MouseEvent<any>): boolean;