@atlaskit/collab-provider 9.4.0 → 9.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/collab-provider
 
+## 9.5.0
+
+### Minor Changes
+
+- [`27f5fbdbb04`](https://bitbucket.org/atlassian/atlassian-frontend/commits/27f5fbdbb04) - ESS-3718: add email as a field in ProviderParticipant to support JWM presence/multiplayer bugfix
+
 ## 9.4.0
 
 ### Minor Changes

package/dist/cjs/participants/participants-helper.js

@@ -25,6 +25,7 @@ var createParticipantFromPayload = /*#__PURE__*/function () {
           participant = {
             name: (user === null || user === void 0 ? void 0 : user.name) || '',
             avatar: (user === null || user === void 0 ? void 0 : user.avatar) || '',
+            email: (user === null || user === void 0 ? void 0 : user.email) || '',
             sessionId: sessionId,
             lastActive: timestamp,
             userId: userId,

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/collab-provider";
 exports.name = name;
-var version = "9.4.0";
+var version = "9.5.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.4.0",
+	"version": "9.5.0",
 	"sideEffects": false
 }

package/dist/es2019/participants/participants-helper.js

@@ -13,6 +13,7 @@ export const createParticipantFromPayload = async (payload, getUser) => {
   const participant = {
     name: (user === null || user === void 0 ? void 0 : user.name) || '',
     avatar: (user === null || user === void 0 ? void 0 : user.avatar) || '',
+    email: (user === null || user === void 0 ? void 0 : user.email) || '',
     sessionId,
     lastActive: timestamp,
     userId,

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.4.0";
+export const version = "9.5.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.4.0",
+	"version": "9.5.0",
 	"sideEffects": false
 }

package/dist/esm/participants/participants-helper.js

@@ -18,6 +18,7 @@ export var createParticipantFromPayload = /*#__PURE__*/function () {
           participant = {
             name: (user === null || user === void 0 ? void 0 : user.name) || '',
             avatar: (user === null || user === void 0 ? void 0 : user.avatar) || '',
+            email: (user === null || user === void 0 ? void 0 : user.email) || '',
             sessionId: sessionId,
             lastActive: timestamp,
             userId: userId,

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.4.0";
+export var version = "9.5.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.4.0",
+	"version": "9.5.0",
 	"sideEffects": false
 }

package/dist/types/participants/participants-helper.d.ts

@@ -3,9 +3,10 @@ export declare const PARTICIPANT_UPDATE_INTERVAL: number;
 export type ProviderParticipant = CollabParticipant & {
     userId: string;
     clientId: number | string;
+    email: string;
 };
 export type ParticipantsMap = Map<string, ProviderParticipant>;
-export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId'>>) | undefined;
+export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId' | 'email'>>) | undefined;
 export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {
     timestamp: number;
 } & {

package/dist/types/types.d.ts

@@ -6,7 +6,7 @@ import type { DisconnectReason } from './disconnected-reason-mapper';
 import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import { ProviderParticipant } from './participants/participants-helper';
+import { GetUserType } from './participants/participants-helper';
 import AnalyticsHelper from './analytics/analytics-helper';
 export interface CollabParticipant {
     lastActive: number;
@@ -78,7 +78,7 @@ export interface Config {
     featureFlags?: {
         [key: string]: boolean;
     };
-    getUser?(userId: string): Promise<Pick<ProviderParticipant, 'avatar' | 'name' | 'userId'>>;
+    getUser?: GetUserType;
     /**
      * If provided, permissionTokenRefresh is called whenever a new JWT token is required.
      */

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

@@ -3,9 +3,10 @@ export declare const PARTICIPANT_UPDATE_INTERVAL: number;
 export type ProviderParticipant = CollabParticipant & {
     userId: string;
     clientId: number | string;
+    email: string;
 };
 export type ParticipantsMap = Map<string, ProviderParticipant>;
-export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId'>>) | undefined;
+export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId' | 'email'>>) | undefined;
 export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {
     timestamp: number;
 } & {

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

@@ -6,7 +6,7 @@ import type { DisconnectReason } from './disconnected-reason-mapper';
 import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import { ProviderParticipant } from './participants/participants-helper';
+import { GetUserType } from './participants/participants-helper';
 import AnalyticsHelper from './analytics/analytics-helper';
 export interface CollabParticipant {
     lastActive: number;
@@ -78,7 +78,7 @@ export interface Config {
     featureFlags?: {
         [key: string]: boolean;
     };
-    getUser?(userId: string): Promise<Pick<ProviderParticipant, 'avatar' | 'name' | 'userId'>>;
+    getUser?: GetUserType;
     /**
      * If provided, permissionTokenRefresh is called whenever a new JWT token is required.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.4.0",
+  "version": "9.5.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -268,9 +268,7 @@ interface Config {
   // (undocumented)
   getAnalyticsWebClient?: Promise<AnalyticsWebClient>;
   // (undocumented)
-  getUser?(
-    userId: string,
-  ): Promise<Pick<ProviderParticipant, 'avatar' | 'name' | 'userId'>>;
+  getUser?: GetUserType;
   // (undocumented)
   initialDraft?: InitialDraft;
   // (undocumented)
@@ -338,6 +336,15 @@ type FailToSave = {
   status?: number;
 };
 
+// @public (undocumented)
+type GetUserType =
+  | ((
+      userId: string,
+    ) => Promise<
+      Pick<ProviderParticipant, 'avatar' | 'email' | 'name' | 'userId'>
+    >)
+  | undefined;
+
 // @public (undocumented)
 interface InitAndAuthData {
   // (undocumented)
@@ -559,6 +566,7 @@ export type ProviderError =
 type ProviderParticipant = CollabParticipant & {
   userId: string;
   clientId: number | string;
+  email: string;
 };
 
 // @public (undocumented)

package/tmp/api-report-tmp.d.ts

@@ -240,7 +240,7 @@ interface Config {
     // (undocumented)
     getAnalyticsWebClient?: Promise<AnalyticsWebClient>;
     // (undocumented)
-    getUser?(userId: string): Promise<Pick<ProviderParticipant, 'avatar' | 'name' | 'userId'>>;
+    getUser?: GetUserType;
     // (undocumented)
     initialDraft?: InitialDraft;
     // (undocumented)
@@ -308,6 +308,9 @@ type FailToSave = {
     status?: number;
 };
 
+// @public (undocumented)
+type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'avatar' | 'email' | 'name' | 'userId'>>) | undefined;
+
 // @public (undocumented)
 interface InitAndAuthData {
     // (undocumented)
@@ -511,6 +514,7 @@ export type ProviderError = DocumentNotFound | DocumentNotRestore | FailToSave |
 type ProviderParticipant = CollabParticipant & {
     userId: string;
     clientId: number | string;
+    email: string;
 };
 
 // @public (undocumented)