@atlaskit/mention 27.18.20 → 27.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @atlaskit/mention
2
2
 
3
+ ## 27.19.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`bd2c5b0112185`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bd2c5b0112185) -
8
+ Remove stale API report artifacts from published Platform packages.
9
+
10
+ ### Patch Changes
11
+
12
+ - Updated dependencies
13
+
14
+ ## 27.18.21
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+
3
20
  ## 27.18.20
4
21
 
5
22
  ### Patch Changes
@@ -31,7 +31,7 @@ var _ufoExperiences = require("./ufoExperiences");
31
31
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
32
32
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
33
33
  function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
34
- function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/ban-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
34
+ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/no-empty-object-type, @typescript-eslint/no-wrapper-object-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
35
35
  var avatarStyles = null;
36
36
  var avatarFallbackStyles = null;
37
37
  var avatarImageStyles = null;
@@ -28,7 +28,7 @@ var _constants = require("../../_constants");
28
28
  * @jsx jsx
29
29
  * @jsxFrag React.Fragment
30
30
  */
31
- /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/ban-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
31
+ /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/no-restricted-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
32
32
 
33
33
  var ANALYTICS_HOVER_DELAY = exports.ANALYTICS_HOVER_DELAY = 1000;
34
34
 
@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.packageVersion = void 0;
7
- var packageVersion = exports.packageVersion = "27.18.19";
7
+ var packageVersion = exports.packageVersion = "27.18.21";
@@ -3,7 +3,7 @@ import _extends from "@babel/runtime/helpers/extends";
3
3
  import _defineProperty from "@babel/runtime/helpers/defineProperty";
4
4
  import "./MentionInternal.compiled.css";
5
5
  import { ax, ix } from "@compiled/react/runtime";
6
- /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/ban-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
6
+ /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/no-empty-object-type, @typescript-eslint/no-wrapper-object-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
7
7
 
8
8
  import React from 'react';
9
9
  import FocusRing from '@atlaskit/focus-ring/focus-ring';
@@ -4,7 +4,7 @@
4
4
  * @jsx jsx
5
5
  * @jsxFrag React.Fragment
6
6
  */
7
- /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/ban-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
7
+ /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/no-restricted-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
8
8
 
9
9
  import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
10
10
  import { fireAnalyticsMentionEvent } from '../../util/fire-analytics-mention-event';
@@ -1 +1 @@
1
- export const packageVersion = "27.18.19";
1
+ export const packageVersion = "27.18.21";
@@ -12,7 +12,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
12
12
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
13
13
  function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
14
14
  function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
15
- /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/ban-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
15
+ /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/no-empty-object-type, @typescript-eslint/no-wrapper-object-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
16
16
 
17
17
  import React from 'react';
18
18
  import FocusRing from '@atlaskit/focus-ring/focus-ring';
@@ -4,7 +4,7 @@
4
4
  * @jsx jsx
5
5
  * @jsxFrag React.Fragment
6
6
  */
7
- /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/ban-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
7
+ /* eslint-disable @atlaskit/design-system/no-deprecated-imports, @typescript-eslint/no-restricted-types -- Preserve existing mention implementation while focus-ring usage is reviewed separately. */
8
8
 
9
9
  import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
10
10
  import { fireAnalyticsMentionEvent } from '../../util/fire-analytics-mention-event';
@@ -1 +1 @@
1
- export var packageVersion = "27.18.19";
1
+ export var packageVersion = "27.18.21";
package/package.json CHANGED
@@ -27,26 +27,26 @@
27
27
  },
28
28
  "dependencies": {
29
29
  "@atlaskit/afm-i18n-platform-elements-mention": "2.200.0",
30
- "@atlaskit/analytics-gas-types": "^6.1.0",
31
- "@atlaskit/analytics-next": "^12.4.0",
32
- "@atlaskit/avatar": "^27.2.0",
30
+ "@atlaskit/analytics-gas-types": "^6.2.0",
31
+ "@atlaskit/analytics-next": "^12.5.0",
32
+ "@atlaskit/avatar": "^27.3.0",
33
33
  "@atlaskit/css": "^1.1.0",
34
- "@atlaskit/focus-ring": "^5.1.0",
35
- "@atlaskit/heading": "^7.1.0",
36
- "@atlaskit/icon": "^37.5.0",
37
- "@atlaskit/lozenge": "^15.3.0",
34
+ "@atlaskit/focus-ring": "^5.2.0",
35
+ "@atlaskit/heading": "^7.2.0",
36
+ "@atlaskit/icon": "^37.6.0",
37
+ "@atlaskit/lozenge": "^15.4.0",
38
38
  "@atlaskit/platform-feature-experiments": "^0.3.0",
39
- "@atlaskit/platform-feature-flags": "^2.1.0",
40
- "@atlaskit/primitives": "^22.4.0",
39
+ "@atlaskit/platform-feature-flags": "^2.2.0",
40
+ "@atlaskit/primitives": "^22.5.0",
41
41
  "@atlaskit/react-compiler-gating": "^0.2.0",
42
- "@atlaskit/skeleton": "^4.3.0",
43
- "@atlaskit/tag": "^15.7.0",
42
+ "@atlaskit/skeleton": "^4.4.0",
43
+ "@atlaskit/tag": "^15.8.0",
44
44
  "@atlaskit/teams-avatar": "^4.1.0",
45
- "@atlaskit/tmp-editor-statsig": "^167.0.0",
46
- "@atlaskit/tokens": "^16.9.0",
47
- "@atlaskit/tooltip": "^24.2.0",
48
- "@atlaskit/ufo": "^1.0.0",
49
- "@atlaskit/util-service-support": "^7.2.0",
45
+ "@atlaskit/tmp-editor-statsig": "^168.0.0",
46
+ "@atlaskit/tokens": "^16.10.0",
47
+ "@atlaskit/tooltip": "^24.3.0",
48
+ "@atlaskit/ufo": "^1.1.0",
49
+ "@atlaskit/util-service-support": "^7.3.0",
50
50
  "@babel/runtime": "^7.0.0",
51
51
  "@compiled/react": "^1.0.2",
52
52
  "@emotion/react": "^11.7.1",
@@ -63,10 +63,11 @@
63
63
  "@atlassian/a11y-jest-testing": "^0.17.0",
64
64
  "@atlassian/a11y-playwright-testing": "^0.12.0",
65
65
  "@atlassian/experiment-test-utils": "^0.2.0",
66
- "@atlassian/feature-flags-test-utils": "^1.2.0",
66
+ "@atlassian/feature-flags-test-utils": "^1.3.0",
67
67
  "@atlassian/testing-library": "^0.11.0",
68
68
  "@testing-library/react": "^16.3.0",
69
69
  "@testing-library/user-event": "^14.4.3",
70
+ "@types/enzyme": "3.1.15",
70
71
  "@types/query-string": "^4.3.1",
71
72
  "@types/serialize-javascript": "^5.0.0",
72
73
  "enzyme": "^3.10.0",
@@ -127,5 +128,5 @@
127
128
  }
128
129
  },
129
130
  "types": "dist/types/index.d.ts",
130
- "version": "27.18.20"
131
+ "version": "27.19.0"
131
132
  }
package/report.api.md DELETED
@@ -1,953 +0,0 @@
1
- <!-- API Report Version: 2.3 -->
2
-
3
- ## API Report File for "@atlaskit/mention"
4
-
5
- > Do not edit this file. This report is auto-generated using
6
- > [API Extractor](https://api-extractor.com/).
7
- > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
8
-
9
- ### Table of contents
10
-
11
- - [Main Entry Types](#main-entry-types)
12
- - [Peer Dependencies](#peer-dependencies)
13
-
14
- ### Main Entry Types
15
-
16
- <!--SECTION START: Main Entry Types-->
17
-
18
- ```ts
19
- import { IntlShape } from 'react-intl';
20
- import { default as React_2 } from 'react';
21
- import { ServiceConfig } from '@atlaskit/util-service-support/types';
22
- import { SyntheticEvent } from 'react';
23
- import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
24
- import { WithAnalyticsEventsProps as WithAnalyticsEventsProps_2 } from '@atlaskit/analytics-next/withAnalyticsEvents';
25
- import { WithIntlProps } from 'react-intl';
26
-
27
- // @public (undocumented)
28
- export class AbstractMentionResource
29
- extends AbstractResource<MentionDescription[]>
30
- implements MentionProvider
31
- {
32
- // (undocumented)
33
- filter(query?: string): void;
34
- // (undocumented)
35
- isFiltering(_query: string): boolean;
36
- // (undocumented)
37
- protected _notifyAllResultsListeners(mentionsResult: MentionsResult): void;
38
- // (undocumented)
39
- protected _notifyAnalyticsListeners(
40
- event: string,
41
- actionSubject: string,
42
- action: string,
43
- attributes?: {
44
- [key: string]: any;
45
- },
46
- ): void;
47
- // (undocumented)
48
- protected _notifyErrorListeners(error: Error, query?: string): void;
49
- // (undocumented)
50
- protected _notifyInfoListeners(info: string): void;
51
- // (undocumented)
52
- protected _notifyListeners(mentionsResult: MentionsResult, stats?: MentionStats): void;
53
- // (undocumented)
54
- recordMentionSelection(_mention: MentionDescription): void;
55
- // (undocumented)
56
- shouldHighlightMention(_mention: MentionDescription): boolean;
57
- }
58
-
59
- // @public (undocumented)
60
- export class AbstractPresenceResource
61
- extends AbstractResource<PresenceMap>
62
- implements PresenceProvider
63
- {
64
- // (undocumented)
65
- protected notifyListeners(presences: PresenceMap): void;
66
- // (undocumented)
67
- refreshPresence(userIds: string[]): void;
68
- }
69
-
70
- // @public (undocumented)
71
- class AbstractResource<Result> implements ResourceProvider<Result> {
72
- constructor();
73
- // (undocumented)
74
- protected allResultsListeners: Map<string, ResultCallback<Result>>;
75
- // (undocumented)
76
- protected analyticsListeners: Map<string, AnalyticsCallback>;
77
- // (undocumented)
78
- protected changeListeners: Map<string, ResultCallback<Result>>;
79
- // (undocumented)
80
- protected errListeners: Map<string, ErrorCallback_2>;
81
- // (undocumented)
82
- protected infoListeners: Map<string, InfoCallback>;
83
- // (undocumented)
84
- subscribe(
85
- key: string,
86
- callback?: ResultCallback<Result>,
87
- errCallback?: ErrorCallback_2,
88
- infoCallback?: InfoCallback,
89
- allResultsCallback?: ResultCallback<Result>,
90
- analyticsListeners?: AnalyticsCallback,
91
- ): void;
92
- // (undocumented)
93
- unsubscribe(key: string): void;
94
- }
95
-
96
- // @public (undocumented)
97
- interface AnalyticsCallback {
98
- // (undocumented)
99
- (
100
- event: string,
101
- actionSubject: string,
102
- action: string,
103
- attributes?: {
104
- [key: string]: any;
105
- },
106
- ): void;
107
- }
108
-
109
- // @public
110
- export class ContextMentionResource implements MentionProvider {
111
- constructor(mentionProvider: MentionProvider, contextIdentifier: MentionContextIdentifier);
112
- // (undocumented)
113
- callDefault: <
114
- K extends
115
- | 'filter'
116
- | 'isFiltering'
117
- | 'recordMentionSelection'
118
- | 'shouldHighlightMention'
119
- | 'subscribe'
120
- | 'unsubscribe',
121
- >(
122
- f: K,
123
- ) => MentionProvider[K];
124
- // (undocumented)
125
- callWithContextIds: <
126
- K extends
127
- | 'filter'
128
- | 'isFiltering'
129
- | 'recordMentionSelection'
130
- | 'shouldHighlightMention'
131
- | 'subscribe'
132
- | 'unsubscribe',
133
- >(
134
- f: K,
135
- declaredArgs: number,
136
- ) => MentionProvider[K];
137
- // (undocumented)
138
- filter: (
139
- query?: string | undefined,
140
- contextIdentifier?: MentionContextIdentifier | undefined,
141
- ) => void;
142
- // (undocumented)
143
- getContextIdentifier(): MentionContextIdentifier | undefined;
144
- // (undocumented)
145
- isFiltering: (query: string) => boolean;
146
- // (undocumented)
147
- recordMentionSelection: (
148
- mention: MentionDescription,
149
- contextIdentifier?: MentionContextIdentifier | undefined,
150
- ) => void;
151
- // (undocumented)
152
- shouldHighlightMention: (mention: MentionDescription) => boolean;
153
- // (undocumented)
154
- subscribe: (
155
- key: string,
156
- callback?: ResultCallback<MentionDescription[]> | undefined,
157
- errCallback?: ErrorCallback_2 | undefined,
158
- infoCallback?: InfoCallback | undefined,
159
- allResultsCallback?: ResultCallback<MentionDescription[]> | undefined,
160
- analyticsCallback?: AnalyticsCallback | undefined,
161
- ) => void;
162
- // (undocumented)
163
- unsubscribe: (key: string) => void;
164
- }
165
-
166
- // @public (undocumented)
167
- interface Data {
168
- // (undocumented)
169
- PresenceBulk: PresenceBulk[];
170
- }
171
-
172
- // @public (undocumented)
173
- export class DefaultMentionNameResolver implements MentionNameResolver {
174
- constructor(client: MentionNameClient, analyticsProps?: WithAnalyticsEventsProps);
175
- // (undocumented)
176
- cacheName(id: string, name: string): void;
177
- // (undocumented)
178
- lookupName(id: string): MentionNameDetails | Promise<MentionNameDetails>;
179
- // (undocumented)
180
- static waitForBatch: number;
181
- }
182
-
183
- // @public (undocumented)
184
- export const ELEMENTS_CHANNEL = 'fabric-elements';
185
-
186
- // @public (undocumented)
187
- interface ErrorCallback_2 {
188
- // (undocumented)
189
- (error: Error, query?: string): void;
190
- }
191
-
192
- // @public (undocumented)
193
- interface Highlight {
194
- // (undocumented)
195
- mentionName: HighlightDetail[];
196
- // (undocumented)
197
- name: HighlightDetail[];
198
- // (undocumented)
199
- nickname: HighlightDetail[];
200
- }
201
-
202
- // @public (undocumented)
203
- interface HighlightDetail {
204
- // (undocumented)
205
- end: number;
206
- // (undocumented)
207
- start: number;
208
- }
209
-
210
- // @public (undocumented)
211
- interface InfoCallback {
212
- // (undocumented)
213
- (info: string): void;
214
- }
215
-
216
- // @public (undocumented)
217
- export type InviteFlow = 'assign' | 'mention';
218
-
219
- // @public (undocumented)
220
- interface InviteFromMentionProvider {
221
- // (undocumented)
222
- onInviteItemClick?(flow: InviteFlow): void;
223
- // (undocumented)
224
- productName?: string;
225
- // (undocumented)
226
- shouldEnableInvite?: boolean;
227
- // (undocumented)
228
- userRole?: UserRole;
229
- }
230
-
231
- // @public (undocumented)
232
- export const isResolvingMentionProvider: (p: any) => p is ResolvingMentionProvider;
233
-
234
- // @public (undocumented)
235
- export function isSpecialMention(mention: MentionDescription): boolean;
236
-
237
- // @public (undocumented)
238
- type LozengeColor = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
239
-
240
- // @public (undocumented)
241
- interface LozengeProps {
242
- // (undocumented)
243
- appearance?: LozengeColor;
244
- // (undocumented)
245
- text: React.ReactNode;
246
- }
247
-
248
- // @public (undocumented)
249
- export const Mention: React_2.ForwardRefExoticComponent<
250
- Omit<Props_5, keyof WithAnalyticsEventsProps_2> & React_2.RefAttributes<any>
251
- >;
252
-
253
- // @public (undocumented)
254
- export type Mention = MentionInternal;
255
-
256
- // @public (undocumented)
257
- export type MentionContextIdentifier = {
258
- containerId?: string;
259
- objectId?: string;
260
- childObjectId?: string;
261
- sessionId?: string;
262
- };
263
-
264
- // @public (undocumented)
265
- interface MentionDescContext {
266
- // (undocumented)
267
- includesYou: boolean;
268
- // (undocumented)
269
- memberCount: number;
270
- // (undocumented)
271
- members: TeamMember[];
272
- // (undocumented)
273
- teamLink: string;
274
- }
275
-
276
- // @public (undocumented)
277
- export interface MentionDescription {
278
- // (undocumented)
279
- accessLevel?: string;
280
- // (undocumented)
281
- avatarUrl?: string;
282
- // (undocumented)
283
- context?: MentionDescContext;
284
- // (undocumented)
285
- highlight?: Highlight;
286
- // (undocumented)
287
- id: string;
288
- // (undocumented)
289
- inContext?: boolean;
290
- // (undocumented)
291
- lozenge?: LozengeProps | string;
292
- // (undocumented)
293
- mentionName?: string;
294
- // (undocumented)
295
- name?: string;
296
- // (undocumented)
297
- nickname?: string;
298
- // (undocumented)
299
- presence?: Presence;
300
- // (undocumented)
301
- source?: string;
302
- // (undocumented)
303
- userType?: string;
304
- }
305
-
306
- // @public (undocumented)
307
- type MentionEventHandler = (
308
- mentionId: string,
309
- text: string,
310
- event?: SyntheticEvent<HTMLSpanElement>,
311
- ) => void;
312
-
313
- // @public (undocumented)
314
- class MentionInternal extends React_2.PureComponent<Props_5, {}> {
315
- constructor(props: Props_5);
316
- // (undocumented)
317
- componentDidMount(): void;
318
- // (undocumented)
319
- componentWillUnmount(): void;
320
- // (undocumented)
321
- render(): JSX.Element;
322
- // (undocumented)
323
- renderUnknownUserError(id: string): JSX.Element;
324
- }
325
-
326
- // @public (undocumented)
327
- export class MentionItem extends React_2.PureComponent<Props, {}> {
328
- // (undocumented)
329
- render(): JSX.Element;
330
- }
331
-
332
- // @public (undocumented)
333
- export class MentionList extends React_2.PureComponent<Props_2, State> {
334
- constructor(props: Props_2);
335
- // (undocumented)
336
- chooseCurrentSelection: () => void;
337
- // (undocumented)
338
- componentDidUpdate(): void;
339
- // (undocumented)
340
- mentionsCount: () => number;
341
- // (undocumented)
342
- render(): JSX.Element;
343
- // (undocumented)
344
- selectId: (id: string, callback?: () => any) => void;
345
- // (undocumented)
346
- selectIndex: (index: number, callback?: () => any) => void;
347
- // (undocumented)
348
- selectNext: () => void;
349
- // (undocumented)
350
- selectPrevious: () => void;
351
- // (undocumented)
352
- UNSAFE_componentWillReceiveProps(nextProps: Props_2): void;
353
- }
354
-
355
- // @public (undocumented)
356
- export interface MentionNameClient {
357
- // (undocumented)
358
- getLookupLimit(): number;
359
- // (undocumented)
360
- lookupMentionNames(ids: string[]): Promise<MentionNameDetails[]>;
361
- }
362
-
363
- // @public (undocumented)
364
- export interface MentionNameDetails {
365
- // (undocumented)
366
- id: string;
367
- // (undocumented)
368
- name?: string;
369
- // (undocumented)
370
- status: MentionNameStatus;
371
- }
372
-
373
- // @public (undocumented)
374
- export interface MentionNameResolver {
375
- // (undocumented)
376
- cacheName(id: string, name: string): void;
377
- // (undocumented)
378
- lookupName(id: string): MentionNameDetails | Promise<MentionNameDetails>;
379
- }
380
-
381
- // @public (undocumented)
382
- export enum MentionNameStatus {
383
- // (undocumented)
384
- OK = 2,
385
- // (undocumented)
386
- SERVICE_ERROR = 1,
387
- // (undocumented)
388
- UNKNOWN = 0,
389
- }
390
-
391
- // @public
392
- class MentionPicker_2 extends React_2.PureComponent<
393
- Props_4 &
394
- WithAnalyticsEventsProps_2 & {
395
- intl: IntlShape;
396
- },
397
- State_3
398
- > {
399
- constructor(
400
- props: Props_4 &
401
- WithAnalyticsEventsProps_2 & {
402
- intl: IntlShape;
403
- },
404
- );
405
- // (undocumented)
406
- chooseCurrentSelection: () => void;
407
- // (undocumented)
408
- componentDidMount(): void;
409
- // (undocumented)
410
- componentWillUnmount(): void;
411
- // (undocumented)
412
- static defaultProps: {
413
- onSelection: () => void;
414
- onOpen: () => void;
415
- onClose: () => void;
416
- };
417
- // (undocumented)
418
- mentionsCount: () => number;
419
- // (undocumented)
420
- render(): JSX.Element;
421
- // (undocumented)
422
- selectId: (id: string, callback?: () => any) => void;
423
- // (undocumented)
424
- selectIndex: (index: number, callback?: () => any) => void;
425
- // (undocumented)
426
- selectNext: () => void;
427
- // (undocumented)
428
- selectPrevious: () => void;
429
- // (undocumented)
430
- UNSAFE_componentWillReceiveProps(nextProps: Props_4 & WithAnalyticsEventsProps_2): void;
431
- }
432
-
433
- // @public (undocumented)
434
- const MentionPickerWithAnalytics: React_2.ForwardRefExoticComponent<
435
- Omit<
436
- Pick<
437
- WithIntlProps<
438
- React_2.PropsWithChildren<
439
- Props_4 &
440
- WithAnalyticsEventsProps_2 & {
441
- intl: IntlShape;
442
- }
443
- >
444
- >,
445
- 'children' | 'createAnalyticsEvent' | 'forwardedRef' | keyof Props_4
446
- > &
447
- React_2.RefAttributes<any>,
448
- keyof WithAnalyticsEventsProps_2
449
- > &
450
- React_2.RefAttributes<any>
451
- >;
452
-
453
- // @public (undocumented)
454
- type MentionPickerWithAnalytics = MentionPicker_2;
455
- export { MentionPickerWithAnalytics as MentionPicker };
456
- export default MentionPickerWithAnalytics;
457
-
458
- // @public (undocumented)
459
- export interface MentionProvider
460
- extends ResourceProvider<MentionDescription[]>,
461
- InviteFromMentionProvider {
462
- // (undocumented)
463
- filter(query?: string, contextIdentifier?: MentionContextIdentifier): void;
464
- // (undocumented)
465
- isFiltering(query: string): boolean;
466
- // (undocumented)
467
- recordMentionSelection(
468
- mention: MentionDescription,
469
- contextIdentifier?: MentionContextIdentifier,
470
- ): void;
471
- // (undocumented)
472
- shouldHighlightMention(mention: MentionDescription): boolean;
473
- }
474
-
475
- // @public
476
- export class MentionResource extends AbstractMentionResource implements ResolvingMentionProvider {
477
- constructor(config: MentionResourceConfig);
478
- // (undocumented)
479
- cacheMentionName(id: string, mentionName: string): void;
480
- // (undocumented)
481
- filter(query?: string, contextIdentifier?: MentionContextIdentifier): Promise<void>;
482
- // (undocumented)
483
- isFiltering(query: string): boolean;
484
- // (undocumented)
485
- notify(searchTime: number, mentionResult: MentionsResult, query?: string): void;
486
- // (undocumented)
487
- notifyError(error: Error, query?: string): void;
488
- // (undocumented)
489
- onInviteItemClick?: (flow: InviteFlow) => void;
490
- // (undocumented)
491
- productName?: string;
492
- // (undocumented)
493
- recordMentionSelection(
494
- mention: MentionDescription,
495
- contextIdentifier?: MentionContextIdentifier,
496
- ): Promise<void>;
497
- // (undocumented)
498
- recordSelection(
499
- mention: MentionDescription,
500
- contextIdentifier?: MentionContextIdentifier,
501
- ): Promise<void>;
502
- protected remoteInitialState(
503
- contextIdentifier?: MentionContextIdentifier,
504
- ): Promise<MentionsResult>;
505
- // (undocumented)
506
- protected remoteSearch(
507
- query: string,
508
- contextIdentifier?: MentionContextIdentifier,
509
- ): Promise<MentionsResult>;
510
- // (undocumented)
511
- resolveMentionName(id: string): MentionNameDetails | Promise<MentionNameDetails>;
512
- // (undocumented)
513
- shouldEnableInvite: boolean;
514
- // (undocumented)
515
- shouldHighlightMention(mention: MentionDescription): boolean;
516
- // (undocumented)
517
- supportsMentionNameResolving(): boolean;
518
- // (undocumented)
519
- protected updateActiveSearches(query: string): void;
520
- // (undocumented)
521
- userRole: UserRole;
522
- // (undocumented)
523
- protected verifyMentionConfig(config: MentionResourceConfig): void;
524
- }
525
-
526
- // @public (undocumented)
527
- export interface MentionResourceConfig extends ServiceConfig {
528
- // (undocumented)
529
- containerId?: string;
530
- // (undocumented)
531
- debounceTime?: number;
532
- // (undocumented)
533
- mentionNameResolver?: MentionNameResolver;
534
- // (undocumented)
535
- onInviteItemClick?: (flow: InviteFlow) => void;
536
- // (undocumented)
537
- productId?: string;
538
- // (undocumented)
539
- productName?: string;
540
- // (undocumented)
541
- shouldEnableInvite?: boolean;
542
- // (undocumented)
543
- shouldHighlightMention?: (mention: MentionDescription) => boolean;
544
- // (undocumented)
545
- userRole?: UserRole;
546
- }
547
-
548
- // @public (undocumented)
549
- export interface MentionsResult {
550
- // (undocumented)
551
- mentions: MentionDescription[];
552
- // (undocumented)
553
- query: string;
554
- }
555
-
556
- // @public (undocumented)
557
- export type MentionStats = {
558
- [key: string]: any;
559
- };
560
-
561
- // @public (undocumented)
562
- interface OnClose {
563
- // (undocumented)
564
- (): void;
565
- }
566
-
567
- // @public (undocumented)
568
- interface OnMentionEvent {
569
- // (undocumented)
570
- (mention: MentionDescription, event?: SyntheticEvent<any>): void;
571
- }
572
-
573
- // @public (undocumented)
574
- interface OnOpen {
575
- // (undocumented)
576
- (): void;
577
- }
578
-
579
- // @public (undocumented)
580
- type OwnProps = {
581
- id: string;
582
- text: string;
583
- isHighlighted?: boolean;
584
- accessLevel?: string;
585
- onClick?: MentionEventHandler;
586
- onMouseEnter?: MentionEventHandler;
587
- onMouseLeave?: MentionEventHandler;
588
- onHover?: () => void;
589
- };
590
-
591
- // @public (undocumented)
592
- type Position = 'above' | 'auto' | 'below';
593
-
594
- // @public (undocumented)
595
- interface Presence {
596
- // (undocumented)
597
- status?: string;
598
- // (undocumented)
599
- time?: string;
600
- }
601
-
602
- // @public (undocumented)
603
- interface PresenceBulk {
604
- // (undocumented)
605
- date: null | string;
606
- // (undocumented)
607
- message: null | string;
608
- // (undocumented)
609
- state: null | string;
610
- // (undocumented)
611
- stateMetadata?: string;
612
- // (undocumented)
613
- type: null | string;
614
- // (undocumented)
615
- userId: string;
616
- }
617
-
618
- // @public (undocumented)
619
- interface PresenceCache {
620
- // (undocumented)
621
- contains(userId: string): boolean;
622
- // (undocumented)
623
- get(userId: string): Presence;
624
- // (undocumented)
625
- getBulk(userIds: string[]): PresenceMap;
626
- // (undocumented)
627
- getMissingUserIds(userIds: string[]): string[];
628
- // (undocumented)
629
- update(presUpdate: PresenceMap): void;
630
- }
631
-
632
- // @public (undocumented)
633
- interface PresenceMap {
634
- // (undocumented)
635
- [userId: string]: Presence;
636
- }
637
-
638
- // @public (undocumented)
639
- interface PresenceParser {
640
- // (undocumented)
641
- mapState(state: string): string;
642
- // (undocumented)
643
- parse(response: PresenceResponse): PresenceMap;
644
- }
645
-
646
- // @public (undocumented)
647
- export interface PresenceProvider extends ResourceProvider<PresenceMap> {
648
- // (undocumented)
649
- refreshPresence(userIds: string[]): void;
650
- }
651
-
652
- // @public (undocumented)
653
- export class PresenceResource extends AbstractPresenceResource {
654
- constructor(config: PresenceResourceConfig);
655
- // (undocumented)
656
- refreshPresence(userIds: string[]): void;
657
- }
658
-
659
- // @public (undocumented)
660
- interface PresenceResourceConfig {
661
- // (undocumented)
662
- cache?: PresenceCache;
663
- // (undocumented)
664
- cacheExpiry?: number;
665
- // (undocumented)
666
- cloudId: string;
667
- // (undocumented)
668
- parser?: PresenceParser;
669
- // (undocumented)
670
- productId?: string;
671
- // (undocumented)
672
- url: string;
673
- }
674
-
675
- // @public (undocumented)
676
- interface PresenceResponse {
677
- // (undocumented)
678
- data: Data;
679
- }
680
-
681
- // @public (undocumented)
682
- interface Props {
683
- // (undocumented)
684
- mention: MentionDescription;
685
- // (undocumented)
686
- onMouseEnter?: OnMentionEvent;
687
- // (undocumented)
688
- onMouseMove?: OnMentionEvent;
689
- // (undocumented)
690
- onSelection?: OnMentionEvent;
691
- // (undocumented)
692
- selected?: boolean;
693
- }
694
-
695
- // @public (undocumented)
696
- interface Props_2 {
697
- // (undocumented)
698
- initialHighlightElement?: React_2.ReactElement | null;
699
- // (undocumented)
700
- mentions: MentionDescription[];
701
- // (undocumented)
702
- onSelection?: OnMentionEvent;
703
- // (undocumented)
704
- resourceError?: Error;
705
- }
706
-
707
- // @public (undocumented)
708
- interface Props_3 {
709
- // (undocumented)
710
- onSelection?: OnMentionEvent;
711
- // (undocumented)
712
- presenceProvider?: PresenceProvider;
713
- // (undocumented)
714
- query?: string;
715
- // (undocumented)
716
- resourceError?: Error;
717
- // (undocumented)
718
- resourceProvider: MentionProvider;
719
- }
720
-
721
- // @public (undocumented)
722
- interface Props_4 {
723
- // (undocumented)
724
- offsetX?: number;
725
- // (undocumented)
726
- offsetY?: number;
727
- // (undocumented)
728
- onClose?: OnClose;
729
- // (undocumented)
730
- onOpen?: OnOpen;
731
- // (undocumented)
732
- onSelection?: OnMentionEvent;
733
- // (undocumented)
734
- position?: Position;
735
- // (undocumented)
736
- presenceProvider?: PresenceProvider;
737
- // (undocumented)
738
- query?: string;
739
- // (undocumented)
740
- resourceProvider: MentionProvider;
741
- // (undocumented)
742
- target?: string;
743
- // (undocumented)
744
- zIndex?: number | string;
745
- }
746
-
747
- // @public (undocumented)
748
- type Props_5 = OwnProps & WithAnalyticsEventsProps_2;
749
-
750
- // @public (undocumented)
751
- interface Props_6 {
752
- // (undocumented)
753
- accessLevel?: string;
754
- // (undocumented)
755
- id: string;
756
- // (undocumented)
757
- mentionProvider?: Promise<MentionProvider>;
758
- // (undocumented)
759
- onClick?: MentionEventHandler;
760
- // (undocumented)
761
- onMouseEnter?: MentionEventHandler;
762
- // (undocumented)
763
- onMouseLeave?: MentionEventHandler;
764
- // (undocumented)
765
- text: string;
766
- }
767
-
768
- // @public
769
- export interface ResolvingMentionProvider extends MentionProvider {
770
- // (undocumented)
771
- cacheMentionName(id: string, mentionName: string): void;
772
- // (undocumented)
773
- resolveMentionName(id: string): MentionNameDetails | Promise<MentionNameDetails>;
774
- // (undocumented)
775
- supportsMentionNameResolving(): boolean;
776
- }
777
-
778
- // @public (undocumented)
779
- export class ResourcedMention extends React_2.PureComponent<Props_6, State_4> {
780
- constructor(props: Props_6);
781
- // (undocumented)
782
- componentDidMount(): void;
783
- // (undocumented)
784
- componentWillUnmount(): void;
785
- // (undocumented)
786
- _isMounted: boolean;
787
- // (undocumented)
788
- render(): JSX.Element;
789
- // (undocumented)
790
- UNSAFE_componentWillReceiveProps(nextProps: Props_6): void;
791
- }
792
-
793
- // @public (undocumented)
794
- export const ResourcedMentionList: React_2.ForwardRefExoticComponent<
795
- Omit<Props_3 & WithAnalyticsEventsProps, keyof WithAnalyticsEventsProps> &
796
- React_2.RefAttributes<any>
797
- >;
798
-
799
- // @public (undocumented)
800
- export type ResourcedMentionList = ResourcedMentionListWithoutAnalytics;
801
-
802
- // @public (undocumented)
803
- class ResourcedMentionListWithoutAnalytics extends React_2.PureComponent<
804
- Props_3 & WithAnalyticsEventsProps,
805
- State_2
806
- > {
807
- constructor(props: Props_3 & WithAnalyticsEventsProps);
808
- // (undocumented)
809
- chooseCurrentSelection: () => void;
810
- // (undocumented)
811
- componentDidMount(): void;
812
- // (undocumented)
813
- componentWillUnmount(): void;
814
- // (undocumented)
815
- mentionsCount: () => number;
816
- // (undocumented)
817
- render(): JSX.Element;
818
- // (undocumented)
819
- selectId: (id: string, callback?: () => any) => void;
820
- // (undocumented)
821
- selectIndex: (index: number, callback?: () => any) => void;
822
- // (undocumented)
823
- selectNext: () => void;
824
- // (undocumented)
825
- selectPrevious: () => void;
826
- // (undocumented)
827
- UNSAFE_componentWillReceiveProps(nextProps: Props_3): void;
828
- }
829
-
830
- // @public (undocumented)
831
- interface ResourceProvider<Result> {
832
- subscribe(
833
- key: string,
834
- callback?: ResultCallback<Result>,
835
- errCallback?: ErrorCallback_2,
836
- infoCallback?: InfoCallback,
837
- allResultsCallback?: ResultCallback<Result>,
838
- analyticsCallback?: AnalyticsCallback,
839
- ): void;
840
- unsubscribe(key: string): void;
841
- }
842
-
843
- // @public (undocumented)
844
- interface ResultCallback<T> {
845
- // (undocumented)
846
- (result: T, query?: string, stats?: MentionStats): void;
847
- }
848
-
849
- // @public (undocumented)
850
- interface State {
851
- // (undocumented)
852
- selectedIndex: number;
853
- // (undocumented)
854
- selectedKey?: string;
855
- }
856
-
857
- // @public (undocumented)
858
- interface State_2 {
859
- // (undocumented)
860
- mentions: MentionDescription[];
861
- // (undocumented)
862
- resourceError?: Error;
863
- }
864
-
865
- // @public (undocumented)
866
- interface State_3 {
867
- // (undocumented)
868
- info?: string;
869
- // (undocumented)
870
- visible: boolean;
871
- }
872
-
873
- // @public (undocumented)
874
- interface State_4 {
875
- // (undocumented)
876
- isHighlighted: boolean;
877
- // (undocumented)
878
- resolvedMentionName?: string;
879
- }
880
-
881
- // @public (undocumented)
882
- export interface TeamMember {
883
- // (undocumented)
884
- id: string;
885
- // (undocumented)
886
- name: string;
887
- }
888
-
889
- // @public
890
- export class TeamMentionResource extends MentionResource implements MentionProvider {
891
- constructor(
892
- userMentionConfig: MentionResourceConfig,
893
- teamMentionConfig: TeamMentionResourceConfig,
894
- );
895
- // (undocumented)
896
- filter(query?: string, contextIdentifier?: MentionContextIdentifier): Promise<void>;
897
- // (undocumented)
898
- notify(searchTime: number, mentionResult: MentionsResult, query?: string): void;
899
- }
900
-
901
- // @public (undocumented)
902
- export interface TeamMentionResourceConfig extends MentionResourceConfig {
903
- // (undocumented)
904
- teamLinkResolver?: (teamId: string) => string;
905
- }
906
-
907
- // @public (undocumented)
908
- export enum UserAccessLevel {
909
- // (undocumented)
910
- APPLICATION = 2,
911
- // (undocumented)
912
- CONTAINER = 3,
913
- // (undocumented)
914
- NONE = 0,
915
- // (undocumented)
916
- SITE = 1,
917
- }
918
-
919
- // @public (undocumented)
920
- export type UserRole = 'admin' | 'basic' | 'trusted';
921
-
922
- // @public (undocumented)
923
- export enum UserType {
924
- // (undocumented)
925
- APP = 2,
926
- // (undocumented)
927
- DEFAULT = 0,
928
- // (undocumented)
929
- SPECIAL = 1,
930
- // (undocumented)
931
- SYSTEM = 4,
932
- // (undocumented)
933
- TEAM = 3,
934
- }
935
-
936
- // (No @packageDocumentation comment for this package)
937
- ```
938
-
939
- <!--SECTION END: Main Entry Types-->
940
-
941
- ### Peer Dependencies
942
-
943
- <!--SECTION START: Peer Dependencies-->
944
-
945
- ```json
946
- {
947
- "react": "^16.8.0",
948
- "react-dom": "^16.8.0",
949
- "react-intl": "npm:react-intl@^5.18.1"
950
- }
951
- ```
952
-
953
- <!--SECTION END: Peer Dependencies-->