@atlaskit/collab-provider 8.8.1 → 8.9.0

package/socket-io-provider/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/socket-io-provider.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/socket-io-provider.d.ts"
+        "../dist/types-ts4.5/socket-io-provider.d.ts"
       ]
     }
   }

package/types/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/types.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/types.d.ts"
+        "../dist/types-ts4.5/types.d.ts"
       ]
     }
   }

package/version-wrapper/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/version-wrapper.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/version-wrapper.d.ts"
+        "../dist/types-ts4.5/version-wrapper.d.ts"
       ]
     }
   }

package/dist/types-ts4.0/feature-flags/types.d.ts

@@ -1,13 +0,0 @@
-export interface NCSFeatureFlags {
-    testFF?: boolean;
-}
-export interface WithNCSFeatureFlags {
-    featureFlags?: NCSFeatureFlags;
-}
-export declare type RequiredNCSFeatureFlags = Record<keyof Required<NCSFeatureFlags>, boolean>;
-export declare type NCSFeatureFlagsMap = Record<keyof Required<NCSFeatureFlags>, string>;
-export declare const supportedProducts: readonly [
-    "confluence"
-];
-export declare type SupportedProduct = (typeof supportedProducts)[number];
-export declare type ProductKeys = Record<SupportedProduct, NCSFeatureFlagsMap>;

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

@@ -1,14 +0,0 @@
-import type { CollabEventPresenceData, CollabParticipant } from '@atlaskit/editor-common/collab';
-import type { CollabEventTelepointerData, PresencePayload } from '../types';
-export declare const PARTICIPANT_UPDATE_INTERVAL: number;
-export declare type ProviderParticipant = CollabParticipant & {
-    userId: string;
-    clientId: number | string;
-};
-export declare type ParticipantsMap = Map<string, ProviderParticipant>;
-export declare type PresenceEmit = (evt: 'presence', data: CollabEventPresenceData) => void;
-export declare type TelepointerEmit = (evt: 'telepointer', data: CollabEventTelepointerData) => void;
-export declare type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId'>>) | undefined;
-export declare const createParticipantFromPayload: (payload: PresencePayload & {
-    userId: string;
-}, getUser: GetUserType) => Promise<ProviderParticipant>;

package/dist/types-ts4.0/participants/participants-service.d.ts

@@ -1,70 +0,0 @@
-import type { CollabEventPresenceData, CollabEventDisconnectedData } from '@atlaskit/editor-common/collab';
-import AnalyticsHelper from '../analytics/analytics-helper';
-import type { CollabEventTelepointerData, PresencePayload, StepJson, TelepointerPayload } from '../types';
-import { GetUserType, TelepointerEmit } from './participants-helper';
-import type { PresenceEmit } from './participants-helper';
-import { ParticipantsState } from './participants-state';
-export declare class ParticipantsService {
-    private participantsState;
-    private participantUpdateTimeout;
-    private analyticsHelper;
-    constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState?: ParticipantsState);
-    /**
-     * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
-     * @param payload Payload from incoming socket event
-     * @param getUser Function to get user data from confluence
-     * @param emit Function to execute emit from provider socket
-     * @returns Awaitable Promise, due to getUser
-     */
-    updateParticipant: (payload: PresencePayload, getUser: GetUserType, emit: PresenceEmit) => Promise<void>;
-    /**
-     * Called when a participant leaves the session.
-     *
-     * We emit the `presence` event to update the active avatars in the editor.
-     */
-    participantLeft: ({ sessionId }: PresencePayload, emit: PresenceEmit) => void;
-    disconnect: (reason: string, sessionId: string | undefined, emit: (evt: 'presence' | 'disconnected', data: CollabEventPresenceData | CollabEventDisconnectedData) => void) => void;
-    /**
-     * Updates when users were last active
-     * @param userIds Users in most recent steps
-     */
-    updateLastActive: (userIds?: string[]) => void;
-    /**
-     * Called on receiving steps, emits each step's telepointer
-     * @param steps Steps to extract telepointers from
-     * @param emit Provider emit function
-     */
-    emitTelepointersFromSteps(steps: StepJson[], emit: TelepointerEmit): void;
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     */
-    participantTelepointer: (payload: TelepointerPayload, thisSessionId: string | undefined, getUser: GetUserType, emit: (evt: 'telepointer' | 'presence', data: CollabEventTelepointerData | CollabEventPresenceData) => void) => void;
-    /**
-     * Every 5 minutes (PARTICIPANT_UPDATE_INTERVAL), removes inactive participants and emits the update to other participants.
-     * Needs to be kicked off in the Provider.
-     * @param sessionId SessionId from provider's connection
-     * @param emit Function to execute emit from provider socket
-     */
-    removeInactiveParticipants: (sessionId: string | undefined, emit: PresenceEmit) => void;
-    /**
-     * Keep list of participants up to date. Filter out inactive users etc.
-     */
-    private filterInactive;
-    /**
-     * Wrapper function to emit with error handling and analytics
-     * @param data Data to emit
-     * @param emit Emit function from Provider
-     */
-    private emitPresence;
-    /**
-     * Wrapper function to emit with error handling and analytics
-     * @param data Data to emit
-     * @param emit Emit function from Provider
-     */
-    private emitTelepointer;
-    /**
-     * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
-     */
-    clearTimers: () => void;
-}