@atlaskit/mention 22.1.1 → 22.1.3

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

@@ -0,0 +1,8 @@
+import MentionResource, { AbstractMentionResource, MentionContextIdentifier, MentionProvider, MentionStats, MentionResourceConfig } from './api/MentionResource';
+import TeamMentionResource from './api/TeamMentionResource';
+import PresenceResource, { PresenceProvider, AbstractPresenceResource } from './api/PresenceResource';
+import { MentionDescription, MentionsResult, isSpecialMention, TeamMember } from './types';
+import { ELEMENTS_CHANNEL } from './_constants';
+import ContextMentionResource from './api/ContextMentionResource';
+export { ContextMentionResource, MentionResource, TeamMentionResource, PresenceResource, AbstractMentionResource, AbstractPresenceResource, isSpecialMention, ELEMENTS_CHANNEL, };
+export type { MentionProvider, PresenceProvider, MentionDescription, MentionsResult, MentionContextIdentifier, MentionStats, TeamMember, MentionResourceConfig, };

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

@@ -0,0 +1,3 @@
+import { MentionPickerWithAnalytics as MentionPicker } from './components/MentionPicker';
+export { MentionPicker as MentionTypeAhead, };
+export default MentionPicker;

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

@@ -0,0 +1,168 @@
+import { SyntheticEvent } from 'react';
+import { ServiceConfig } from '@atlaskit/util-service-support/types';
+export interface MentionNameResolver {
+    lookupName(id: string): Promise<MentionNameDetails> | MentionNameDetails;
+    cacheName(id: string, name: string): void;
+}
+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;
+}
+export interface MentionResourceConfig extends ServiceConfig {
+    containerId?: string;
+    productId?: string;
+    shouldHighlightMention?: (mention: MentionDescription) => boolean;
+    inviteExperimentCohort?: InviteExperimentCohort;
+    mentionNameResolver?: MentionNameResolver;
+    shouldEnableInvite?: boolean;
+    onInviteItemClick?: (flow: InviteFlow) => void;
+    userRole?: UserRole;
+    productName?: string;
+    debounceTime?: number;
+}
+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 = {
+    containerId?: string;
+    objectId?: string;
+    childObjectId?: string;
+    sessionId?: string;
+};
+export interface MentionProvider extends ResourceProvider<MentionDescription[]>, InviteFromMentionProvider {
+    filter(query?: string, contextIdentifier?: MentionContextIdentifier): void;
+    recordMentionSelection(mention: MentionDescription, contextIdentifier?: MentionContextIdentifier): void;
+    shouldHighlightMention(mention: MentionDescription): boolean;
+    isFiltering(query: string): boolean;
+}
+export interface HighlightDetail {
+    start: number;
+    end: number;
+}
+export interface Highlight {
+    name: HighlightDetail[];
+    mentionName: HighlightDetail[];
+    nickname: HighlightDetail[];
+}
+export interface Presence {
+    time?: string;
+    status?: string;
+}
+export type LozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'new' | 'moved';
+export interface LozengeProps {
+    text: React.ReactNode;
+    appearance?: LozengeColor;
+}
+export interface MentionDescription {
+    id: string;
+    avatarUrl?: string;
+    name?: string;
+    mentionName?: string;
+    nickname?: string;
+    highlight?: Highlight;
+    lozenge?: string | LozengeProps;
+    presence?: Presence;
+    accessLevel?: string;
+    inContext?: boolean;
+    userType?: string;
+    context?: MentionDescContext;
+    source?: string;
+}
+export interface MentionDescContext {
+    members: TeamMember[];
+    includesYou: boolean;
+    memberCount: number;
+    teamLink: string;
+}
+export interface MentionsResult {
+    mentions: MentionDescription[];
+    query: string;
+}
+export interface TeamMember {
+    id: string;
+    name: string;
+}
+export interface Team {
+    id: string;
+    smallAvatarImageUrl: string;
+    displayName: string;
+    members: TeamMember[];
+    includesYou: boolean;
+    memberCount: number;
+    highlight?: Highlight;
+}
+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
+}
+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 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 type InviteExperimentCohort = 'variation' | 'control' | 'not-enrolled';
+export interface InviteFromMentionProvider {
+    productName?: string;
+    shouldEnableInvite?: boolean;
+    inviteExperimentCohort?: InviteExperimentCohort;
+    onInviteItemClick?(flow: InviteFlow): void;
+    userRole?: UserRole;
+}

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

@@ -0,0 +1,30 @@
+import { UIAnalyticsEvent, WithAnalyticsEventsProps, CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { GasPayload } from '@atlaskit/analytics-gas-types';
+export declare const SLI_EVENT_TYPE = "sli";
+export declare const SMART_EVENT_TYPE = "smart";
+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 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;
+} | undefined) => 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/i18n.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+import { MessageDescriptor } from 'react-intl-next';
+export type Formatter = (props: {
+    values?: {
+        [k: string]: string;
+    };
+    children?(props: string): React.ReactElement;
+}) => 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

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

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

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

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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,8 @@
+import { 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/mention",
-  "version": "22.1.1",
+  "version": "22.1.3",
   "description": "A React component used to display user profiles in a list for 'Mention' functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
   "atlassian": {
     "team": "Search Platform: Search Experience",
     "deprecatedAutoEntryPoints": true,
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
     "website": {
       "name": "Mention"
     }
@@ -41,7 +41,7 @@
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/lozenge": "^11.4.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.4.0",
+    "@atlaskit/tokens": "^1.14.0",
     "@atlaskit/tooltip": "^17.8.0",
     "@atlaskit/ufo": "^0.2.0",
     "@atlaskit/util-service-support": "^6.2.0",
@@ -57,13 +57,8 @@
     "react-intl-next": "npm:react-intl@^5.18.1"
   },
   "devDependencies": {
-    "@atlaskit/adf-utils": "^18.2.0",
-    "@atlaskit/docs": "^9.1.0",
-    "@atlaskit/editor-core": "^183.0.0",
-    "@atlaskit/editor-test-helpers": "^18.3.0",
+    "@atlaskit/editor-test-helpers": "^18.10.0",
     "@atlaskit/elements-test-helpers": "^0.7.0",
-    "@atlaskit/section-message": "^6.4.0",
-    "@atlaskit/ssr": "*",
     "@atlaskit/util-data-test": "^17.8.0",
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",

package/report.api.md

@@ -362,9 +362,9 @@ export class MentionList extends React_2.PureComponent<Props_2, State> {
   // (undocumented)
   render(): JSX.Element;
   // (undocumented)
-  selectId: (id: string, callback?: (() => any) | undefined) => void;
+  selectId: (id: string, callback?: () => any) => void;
   // (undocumented)
-  selectIndex: (index: number, callback?: (() => any) | undefined) => void;
+  selectIndex: (index: number, callback?: () => any) => void;
   // (undocumented)
   selectNext: () => void;
   // (undocumented)
@@ -440,9 +440,9 @@ class MentionPicker_2 extends React_2.PureComponent<
   // (undocumented)
   render(): JSX.Element;
   // (undocumented)
-  selectId: (id: string, callback?: (() => any) | undefined) => void;
+  selectId: (id: string, callback?: () => any) => void;
   // (undocumented)
-  selectIndex: (index: number, callback?: (() => any) | undefined) => void;
+  selectIndex: (index: number, callback?: () => any) => void;
   // (undocumented)
   selectNext: () => void;
   // (undocumented)
@@ -857,9 +857,9 @@ class ResourcedMentionListWithoutAnalytics extends React_2.PureComponent<
   // (undocumented)
   render(): JSX.Element;
   // (undocumented)
-  selectId: (id: string, callback?: (() => any) | undefined) => void;
+  selectId: (id: string, callback?: () => any) => void;
   // (undocumented)
-  selectIndex: (index: number, callback?: (() => any) | undefined) => void;
+  selectIndex: (index: number, callback?: () => any) => void;
   // (undocumented)
   selectNext: () => void;
   // (undocumented)