@juki-team/commons 0.1.42 → 0.1.43

package/dist/cjs/index.cjs

@@ -582,6 +582,10 @@ exports.WebSocketMessageEvent = void 0;
     WebSocketMessageEvent["CLIENT_TRACK_DEVICE"] = "CLIENT_TRACK_DEVICE";
     WebSocketMessageEvent["CHAT_COMPLETIONS"] = "CHAT_COMPLETIONS";
 })(exports.WebSocketMessageEvent || (exports.WebSocketMessageEvent = {}));
+/**
+ * Subscriptions of the client. With the TOPIC channels they are not sent to the server anymore:
+ * they only say which channel the client attaches (`getChannelOfWebSocketSubscribeEvent`) and the dispatch key.
+ */
 exports.WebSocketSubscriptionEvent = void 0;
 (function (WebSocketSubscriptionEvent) {
     WebSocketSubscriptionEvent["SUBSCRIBE_CODE_RUN_STATUS"] = "SUBSCRIBE_CODE_RUN_STATUS";
@@ -2241,10 +2245,15 @@ const EMPTY_USER_PERMISSIONS = {
 };
 
 // LEGACY channels (fan-out per client through the subscriptions registry in Redis)
+/** @deprecated the subscriptions registry was replaced by the TOPIC channels granted in the Ably token */
 const CHANNEL_PUBLISH_SUBSCRIPTIONS = 'pub:subscriptions';
+/** @deprecated not used, the events arrive by the TOPIC channels */
 const CHANNEL_SUBSCRIBE_NOTIFICATIONS = 'sub:notifications';
+/** @deprecated the events arrive by the TOPIC channels */
 const CHANNEL_SUBSCRIBE_CLIENT = (clientId) => `sub:client:${clientId}`;
+/** messages from the clients to the backend (chat completions, client track screenshots) */
 const CHANNEL_PUBLISH_MESSAGES = 'pub:messages';
+/** @deprecated global presence channel (limited to 200 members by Ably), replaced by CHANNEL_COMPANY_PRESENCE */
 const CHANNEL_PRESENCE_CLIENT = 'pre:client';
 // TOPIC channels
 // The backend publishes each event once on the channel of its topic and Ably does the fan-out.
@@ -2263,6 +2272,14 @@ const CHANNEL_PROBLEM = (problemKey) => `problem:${segment(problemKey)}`;
 const CHANNEL_CONTEST = (contestKey, role) => `contest:${segment(contestKey)}:${role}`;
 /** system administrators only: data sent by a tracked client (screenshots, location, device) */
 const CHANNEL_CLIENT_TRACK = (trackedClientId) => `client-track:${segment(trackedClientId)}`;
+/**
+ * presence of the clients (tabs) of the logged users of a company (by its key), data: `UserPresenceData`.
+ * The clients only enter (capability `presence`), only the administrators of the company receive it
+ * (capability `presence-subscribe`). Ably limits the presence members per channel (200 by default,
+ * more with server-side batching enabled on the `presence` namespace).
+ * The identity of a member is its `clientId` (`sessionId|uiId`, verified by Ably), never its data.
+ */
+const CHANNEL_COMPANY_PRESENCE = (companyKey) => `presence:company:${segment(companyKey)}`;
 // capability resources (wildcards) of the public channels
 const CHANNEL_SUBMISSION_ALL = 'submission:*';
 const CHANNEL_PROBLEM_ALL = 'problem:*';
@@ -3478,6 +3495,7 @@ exports.AssignmentState = AssignmentState;
 exports.AssignmentType = AssignmentType;
 exports.CHANNEL_CLIENT_TRACK = CHANNEL_CLIENT_TRACK;
 exports.CHANNEL_CLIENT_TRACK_ALL = CHANNEL_CLIENT_TRACK_ALL;
+exports.CHANNEL_COMPANY_PRESENCE = CHANNEL_COMPANY_PRESENCE;
 exports.CHANNEL_CONTEST = CHANNEL_CONTEST;
 exports.CHANNEL_PRESENCE_CLIENT = CHANNEL_PRESENCE_CLIENT;
 exports.CHANNEL_PROBLEM = CHANNEL_PROBLEM;

package/dist/esm/index.js

@@ -580,6 +580,10 @@ var WebSocketMessageEvent;
     WebSocketMessageEvent["CLIENT_TRACK_DEVICE"] = "CLIENT_TRACK_DEVICE";
     WebSocketMessageEvent["CHAT_COMPLETIONS"] = "CHAT_COMPLETIONS";
 })(WebSocketMessageEvent || (WebSocketMessageEvent = {}));
+/**
+ * Subscriptions of the client. With the TOPIC channels they are not sent to the server anymore:
+ * they only say which channel the client attaches (`getChannelOfWebSocketSubscribeEvent`) and the dispatch key.
+ */
 var WebSocketSubscriptionEvent;
 (function (WebSocketSubscriptionEvent) {
     WebSocketSubscriptionEvent["SUBSCRIBE_CODE_RUN_STATUS"] = "SUBSCRIBE_CODE_RUN_STATUS";
@@ -2239,10 +2243,15 @@ const EMPTY_USER_PERMISSIONS = {
 };
 
 // LEGACY channels (fan-out per client through the subscriptions registry in Redis)
+/** @deprecated the subscriptions registry was replaced by the TOPIC channels granted in the Ably token */
 const CHANNEL_PUBLISH_SUBSCRIPTIONS = 'pub:subscriptions';
+/** @deprecated not used, the events arrive by the TOPIC channels */
 const CHANNEL_SUBSCRIBE_NOTIFICATIONS = 'sub:notifications';
+/** @deprecated the events arrive by the TOPIC channels */
 const CHANNEL_SUBSCRIBE_CLIENT = (clientId) => `sub:client:${clientId}`;
+/** messages from the clients to the backend (chat completions, client track screenshots) */
 const CHANNEL_PUBLISH_MESSAGES = 'pub:messages';
+/** @deprecated global presence channel (limited to 200 members by Ably), replaced by CHANNEL_COMPANY_PRESENCE */
 const CHANNEL_PRESENCE_CLIENT = 'pre:client';
 // TOPIC channels
 // The backend publishes each event once on the channel of its topic and Ably does the fan-out.
@@ -2261,6 +2270,14 @@ const CHANNEL_PROBLEM = (problemKey) => `problem:${segment(problemKey)}`;
 const CHANNEL_CONTEST = (contestKey, role) => `contest:${segment(contestKey)}:${role}`;
 /** system administrators only: data sent by a tracked client (screenshots, location, device) */
 const CHANNEL_CLIENT_TRACK = (trackedClientId) => `client-track:${segment(trackedClientId)}`;
+/**
+ * presence of the clients (tabs) of the logged users of a company (by its key), data: `UserPresenceData`.
+ * The clients only enter (capability `presence`), only the administrators of the company receive it
+ * (capability `presence-subscribe`). Ably limits the presence members per channel (200 by default,
+ * more with server-side batching enabled on the `presence` namespace).
+ * The identity of a member is its `clientId` (`sessionId|uiId`, verified by Ably), never its data.
+ */
+const CHANNEL_COMPANY_PRESENCE = (companyKey) => `presence:company:${segment(companyKey)}`;
 // capability resources (wildcards) of the public channels
 const CHANNEL_SUBMISSION_ALL = 'submission:*';
 const CHANNEL_PROBLEM_ALL = 'problem:*';
@@ -3470,4 +3487,4 @@ const isQuizTextSheet = (value) => {
         && ['text', 'number', 'textarea'].includes(value?.inputType);
 };
 
-export { ACCEPTED_PROGRAMMING_LANGUAGES, ASPECT_RATIO, AspectRatio, AssignmentClass, AssignmentState, AssignmentType, CHANNEL_CLIENT_TRACK, CHANNEL_CLIENT_TRACK_ALL, CHANNEL_CONTEST, CHANNEL_PRESENCE_CLIENT, CHANNEL_PROBLEM, CHANNEL_PROBLEM_ALL, CHANNEL_PUBLISH_MESSAGES, CHANNEL_PUBLISH_SUBSCRIPTIONS, CHANNEL_SESSION, CHANNEL_SUBMISSION, CHANNEL_SUBMISSION_ALL, CHANNEL_SUBSCRIBE_CLIENT, CHANNEL_SUBSCRIBE_NOTIFICATIONS, CHANNEL_USER, CODE_LANGUAGE, COMPANY_PLAN, CONTEST_ROLE, CONTEST_STATUS, COOKIE_JUKI_SESSION_ID, COURSE_ROLE, CodeLanguage, CollectionKey, CompanyLogoType, CompanyPlan, ContestChannelRole, ContestEventAction, ContestProblemBlockedByType, ContestProblemPrerequisiteType, ContestStatus, ContestTimeStatus, CourseRole, CourseStatus, CourseType, DAY_NAMES, DEFAULT_JUKI_PROFILE_IMAGE, DataViewMode, EMPTY_DOCUMENT_MEMBERS, EMPTY_ENTITY_MEMBERS, EMPTY_USER_PERMISSIONS, ENTITY_ACCESS, ENTITY_STATE, ERROR, EmailSubscription, EmailValidationState, EntityAccess, EntityCollection, EntityMembersRank, EntityState, EntityStatus, ErrorCode, FILE_ROLE, FILE_TYPE, FileMemberRole, FileType, FilesJukiPub, GroupType, HEADER_JUKI_FORWARDED_HOST, HEADER_JUKI_INTERNAL_API_KEY, HEADER_JUKI_METADATA, HEADER_JUKI_SECRET_TOKEN, HEADER_JUKI_VISITOR_SESSION_ID, HOURS, HTTPMethod, JUDGE, JUKI_APP_COMPANY_KEY, JUKI_APP_EMAIL_TEMPLATE, JkError, Judge, LANGUAGE, LOWERCASE_LETTERS, Language, LogLevel, LogOperation, MAX_DATE, MEMBER_ROLE, MILLISECONDS, MINUTES, MIN_DATE, MONTH_NAMES, MemberRole, MemberType, MenuViewMode, NEW_PAGE_SHEET, NUMBERS, NotificationType, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, PAGE, PAGE_SIZE, PAGE_SIZES, PALLETE, PROBLEM_INPUT, PROBLEM_MODE, PROBLEM_MODES, PROBLEM_OUTPUT, PROBLEM_ROLE, PROBLEM_TYPE, PROBLEM_TYPES, PROBLEM_VERDICT, PROBLEM_VERDICTS, ProblemInput, ProblemOutput, ProblemScoringMode, ProblemType, ProblemVerdict, ProfileSetting, QuizScoringMode, RUNNER_ACCEPTED_PROBLEM_MODES, RUNNER_ACCEPTED_PROBLEM_TYPES, RUNNER_ACCEPTED_PROGRAMMING_LANGUAGES, RUNNER_TYPE, Role, RunnerType, SECONDS, SEC_120, SEC_30, SEC_60, SEC_90, SEPARATOR_TOKEN, SUBMISSION_RUN_STATUS, SUPPORT_EMAIL, SYSTEM_ROLE, ScopeData, Status, SubmissionRunStatus, SystemRole, TEAM_ROLE, THEME, TeamRole, TeamStatus, Theme, TypeTestCase, UPPERCASE_LETTERS, USER_ROLE, USER_STATUS, UserRole, UserStatus, UserTeamStatus, WebSocketMessageEvent, WebSocketResponseEvent, WebSocketSubscriptionEvent, WorkingIn, WorksheetType, YEARS, _KEY, _SUB_SUB_TAB, _SUB_TAB, _TAB, _TYPE, areArraysDifferent, chunkString, cleanRequest, clearAsyncInterval, consoleError, consoleInfo, consoleWarn, contentResponse, contentsResponse, errorsResponse, getAssignmentCommentKey, getAssignmentUserCommentKey, getChannelOfWebSocketSubscribeEvent, getClientId, getContestChannelParams, getContestCommentKey, getContestKeyOfWebSocketSubscribeEvent, getDataLog, getDataOfTestCase, getDays, getDefaultMeta, getDocumentAccess, getHours, getMilliseconds, getMinutes, getMonths, getParamsOfClientId, getParamsOfUserKey, getPlainText, getProblemCommentKey, getProblemJudgeKey, getRandomString, getSeconds, getSummaryWorksheetsInPages, getTotalExercisesOfSummaryWorksheetsInPages, getUserKey, getVerdictFromTestCase, getWebSocketResponseEventKey, getWebSocketResponseEventKeyOfResponse, getWorksheetsInPages, getYears, humanFileSize, indexToLetters, isBasicWorksheet, isChatCompletionsWebSocketEventDTO, isClientTrackDeviceWebSocketEventDTO, isClientTrackLocationWebSocketEventDTO, isClientTrackScreenshotWebSocketEventDTO, isClientTrackWebSocketResponseEventDTO, isCodeEditorSheet, isCodeRunStatusMessageWebSocketResponseEventDTO, isContestAssignment, isContestChangesWebSocketResponseEventDTO, isCourseAssignment, isEndlessContest, isFutureContest, isGlobalContest, isJkmdSheet, isObjectJson, isPastContest, isPingWebSocketEventDTO, isPongWebSocketResponseEventDTO, isProblemCrawledWebSocketResponseEventDTO, isQuizOptionsSheet, isQuizProblemSheet, isQuizTextSheet, isSenDataChatCompletionsWebSocketResponseEventDTO, isSendDataClientTrackWebSocketResponseEventDTO, isSendDataEc2InstancesListWebSocketResponseEventDTO, isSendDataEcsTaskDefinitionListWebSocketResponseEventDTO, isSendDataEcsTasksListWebSocketResponseEventDTO, isSendDataRunCommandWebSocketResponseEventDTO, isSendDataSsmSessionsListWebSocketResponseEventDTO, isSendDataWebSocketResponseEventDTO, isStringJson, isSubmissionRunStatusMessageWebSocketResponseEventDTO, isSubmissionsCrawlWebSocketResponseEventDTO, isSubscribeClientTrackDataWebSocketEventDTO, isSubscribeClientTrackWebSocketEventDTO, isSubscribeCodeRunStatusWebSocketEventDTO, isSubscribeContestChangesWebSocketEventDTO, isSubscribeGetDataWebSocketEventDTO, isSubscribeProblemCrawledWebSocketEventDTO, isSubscribeSubmissionRunStatusWebSocketEventDTO, isSubscribeSubmissionsCrawlWebSocketEventDTO, isSubscribeUserNotificationWebSocketEventDTO, isTeamMember, isUnsubscribeClientTrackDataWebSocketEventDTO, isUnsubscribeClientTrackWebSocketEventDTO, isUnsubscribeCodeRunStatusWebSocketEventDTO, isUnsubscribeContestChangesWebSocketEventDTO, isUnsubscribeGetDataWebSocketEventDTO, isUnsubscribeProblemCrawledWebSocketEventDTO, isUnsubscribeSubmissionRunStatusWebSocketEventDTO, isUnsubscribeSubmissionsCrawlWebSocketEventDTO, isUnsubscribeUserNotificationWebSocketEventDTO, isUserMember, isUserMessageWebSocketResponseEventDTO, isUserNotificationContestClarificationWebSocketResponseEventDTO, isUserNotificationSubmissionWebSocketResponseEventDTO, isUserNotificationWebSocketResponseEventDTO, isWebSocketChannelsMessageDTO, isWebSocketResponseEventDTO, isWebsocketSubscription, isWorksheetAssignment, join, lettersToIndex, memorySizeOf, mergeVerdicts, mex, normalizeToLocalStartOfDay, normalizeToLocalStartOfHour, normalizeToLocalStartOfMinutes, normalizeToLocalStartOfSeconds, objectUpdate, objectsUpdate, range, removeExtension, safeJsonParse, setAsyncInterval, split, splitTime, stringToArrayBuffer, toEntityMembersDTO, toJkError };
+export { ACCEPTED_PROGRAMMING_LANGUAGES, ASPECT_RATIO, AspectRatio, AssignmentClass, AssignmentState, AssignmentType, CHANNEL_CLIENT_TRACK, CHANNEL_CLIENT_TRACK_ALL, CHANNEL_COMPANY_PRESENCE, CHANNEL_CONTEST, CHANNEL_PRESENCE_CLIENT, CHANNEL_PROBLEM, CHANNEL_PROBLEM_ALL, CHANNEL_PUBLISH_MESSAGES, CHANNEL_PUBLISH_SUBSCRIPTIONS, CHANNEL_SESSION, CHANNEL_SUBMISSION, CHANNEL_SUBMISSION_ALL, CHANNEL_SUBSCRIBE_CLIENT, CHANNEL_SUBSCRIBE_NOTIFICATIONS, CHANNEL_USER, CODE_LANGUAGE, COMPANY_PLAN, CONTEST_ROLE, CONTEST_STATUS, COOKIE_JUKI_SESSION_ID, COURSE_ROLE, CodeLanguage, CollectionKey, CompanyLogoType, CompanyPlan, ContestChannelRole, ContestEventAction, ContestProblemBlockedByType, ContestProblemPrerequisiteType, ContestStatus, ContestTimeStatus, CourseRole, CourseStatus, CourseType, DAY_NAMES, DEFAULT_JUKI_PROFILE_IMAGE, DataViewMode, EMPTY_DOCUMENT_MEMBERS, EMPTY_ENTITY_MEMBERS, EMPTY_USER_PERMISSIONS, ENTITY_ACCESS, ENTITY_STATE, ERROR, EmailSubscription, EmailValidationState, EntityAccess, EntityCollection, EntityMembersRank, EntityState, EntityStatus, ErrorCode, FILE_ROLE, FILE_TYPE, FileMemberRole, FileType, FilesJukiPub, GroupType, HEADER_JUKI_FORWARDED_HOST, HEADER_JUKI_INTERNAL_API_KEY, HEADER_JUKI_METADATA, HEADER_JUKI_SECRET_TOKEN, HEADER_JUKI_VISITOR_SESSION_ID, HOURS, HTTPMethod, JUDGE, JUKI_APP_COMPANY_KEY, JUKI_APP_EMAIL_TEMPLATE, JkError, Judge, LANGUAGE, LOWERCASE_LETTERS, Language, LogLevel, LogOperation, MAX_DATE, MEMBER_ROLE, MILLISECONDS, MINUTES, MIN_DATE, MONTH_NAMES, MemberRole, MemberType, MenuViewMode, NEW_PAGE_SHEET, NUMBERS, NotificationType, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, PAGE, PAGE_SIZE, PAGE_SIZES, PALLETE, PROBLEM_INPUT, PROBLEM_MODE, PROBLEM_MODES, PROBLEM_OUTPUT, PROBLEM_ROLE, PROBLEM_TYPE, PROBLEM_TYPES, PROBLEM_VERDICT, PROBLEM_VERDICTS, ProblemInput, ProblemOutput, ProblemScoringMode, ProblemType, ProblemVerdict, ProfileSetting, QuizScoringMode, RUNNER_ACCEPTED_PROBLEM_MODES, RUNNER_ACCEPTED_PROBLEM_TYPES, RUNNER_ACCEPTED_PROGRAMMING_LANGUAGES, RUNNER_TYPE, Role, RunnerType, SECONDS, SEC_120, SEC_30, SEC_60, SEC_90, SEPARATOR_TOKEN, SUBMISSION_RUN_STATUS, SUPPORT_EMAIL, SYSTEM_ROLE, ScopeData, Status, SubmissionRunStatus, SystemRole, TEAM_ROLE, THEME, TeamRole, TeamStatus, Theme, TypeTestCase, UPPERCASE_LETTERS, USER_ROLE, USER_STATUS, UserRole, UserStatus, UserTeamStatus, WebSocketMessageEvent, WebSocketResponseEvent, WebSocketSubscriptionEvent, WorkingIn, WorksheetType, YEARS, _KEY, _SUB_SUB_TAB, _SUB_TAB, _TAB, _TYPE, areArraysDifferent, chunkString, cleanRequest, clearAsyncInterval, consoleError, consoleInfo, consoleWarn, contentResponse, contentsResponse, errorsResponse, getAssignmentCommentKey, getAssignmentUserCommentKey, getChannelOfWebSocketSubscribeEvent, getClientId, getContestChannelParams, getContestCommentKey, getContestKeyOfWebSocketSubscribeEvent, getDataLog, getDataOfTestCase, getDays, getDefaultMeta, getDocumentAccess, getHours, getMilliseconds, getMinutes, getMonths, getParamsOfClientId, getParamsOfUserKey, getPlainText, getProblemCommentKey, getProblemJudgeKey, getRandomString, getSeconds, getSummaryWorksheetsInPages, getTotalExercisesOfSummaryWorksheetsInPages, getUserKey, getVerdictFromTestCase, getWebSocketResponseEventKey, getWebSocketResponseEventKeyOfResponse, getWorksheetsInPages, getYears, humanFileSize, indexToLetters, isBasicWorksheet, isChatCompletionsWebSocketEventDTO, isClientTrackDeviceWebSocketEventDTO, isClientTrackLocationWebSocketEventDTO, isClientTrackScreenshotWebSocketEventDTO, isClientTrackWebSocketResponseEventDTO, isCodeEditorSheet, isCodeRunStatusMessageWebSocketResponseEventDTO, isContestAssignment, isContestChangesWebSocketResponseEventDTO, isCourseAssignment, isEndlessContest, isFutureContest, isGlobalContest, isJkmdSheet, isObjectJson, isPastContest, isPingWebSocketEventDTO, isPongWebSocketResponseEventDTO, isProblemCrawledWebSocketResponseEventDTO, isQuizOptionsSheet, isQuizProblemSheet, isQuizTextSheet, isSenDataChatCompletionsWebSocketResponseEventDTO, isSendDataClientTrackWebSocketResponseEventDTO, isSendDataEc2InstancesListWebSocketResponseEventDTO, isSendDataEcsTaskDefinitionListWebSocketResponseEventDTO, isSendDataEcsTasksListWebSocketResponseEventDTO, isSendDataRunCommandWebSocketResponseEventDTO, isSendDataSsmSessionsListWebSocketResponseEventDTO, isSendDataWebSocketResponseEventDTO, isStringJson, isSubmissionRunStatusMessageWebSocketResponseEventDTO, isSubmissionsCrawlWebSocketResponseEventDTO, isSubscribeClientTrackDataWebSocketEventDTO, isSubscribeClientTrackWebSocketEventDTO, isSubscribeCodeRunStatusWebSocketEventDTO, isSubscribeContestChangesWebSocketEventDTO, isSubscribeGetDataWebSocketEventDTO, isSubscribeProblemCrawledWebSocketEventDTO, isSubscribeSubmissionRunStatusWebSocketEventDTO, isSubscribeSubmissionsCrawlWebSocketEventDTO, isSubscribeUserNotificationWebSocketEventDTO, isTeamMember, isUnsubscribeClientTrackDataWebSocketEventDTO, isUnsubscribeClientTrackWebSocketEventDTO, isUnsubscribeCodeRunStatusWebSocketEventDTO, isUnsubscribeContestChangesWebSocketEventDTO, isUnsubscribeGetDataWebSocketEventDTO, isUnsubscribeProblemCrawledWebSocketEventDTO, isUnsubscribeSubmissionRunStatusWebSocketEventDTO, isUnsubscribeSubmissionsCrawlWebSocketEventDTO, isUnsubscribeUserNotificationWebSocketEventDTO, isUserMember, isUserMessageWebSocketResponseEventDTO, isUserNotificationContestClarificationWebSocketResponseEventDTO, isUserNotificationSubmissionWebSocketResponseEventDTO, isUserNotificationWebSocketResponseEventDTO, isWebSocketChannelsMessageDTO, isWebSocketResponseEventDTO, isWebsocketSubscription, isWorksheetAssignment, join, lettersToIndex, memorySizeOf, mergeVerdicts, mex, normalizeToLocalStartOfDay, normalizeToLocalStartOfHour, normalizeToLocalStartOfMinutes, normalizeToLocalStartOfSeconds, objectUpdate, objectsUpdate, range, removeExtension, safeJsonParse, setAsyncInterval, split, splitTime, stringToArrayBuffer, toEntityMembersDTO, toJkError };

package/dist/types/constants/websocket.d.ts

@@ -1,8 +1,13 @@
 import { ClientId, ContestChannelRole } from '../types';
+/** @deprecated the subscriptions registry was replaced by the TOPIC channels granted in the Ably token */
 export declare const CHANNEL_PUBLISH_SUBSCRIPTIONS = "pub:subscriptions";
+/** @deprecated not used, the events arrive by the TOPIC channels */
 export declare const CHANNEL_SUBSCRIBE_NOTIFICATIONS = "sub:notifications";
+/** @deprecated the events arrive by the TOPIC channels */
 export declare const CHANNEL_SUBSCRIBE_CLIENT: (clientId: ClientId) => string;
+/** messages from the clients to the backend (chat completions, client track screenshots) */
 export declare const CHANNEL_PUBLISH_MESSAGES = "pub:messages";
+/** @deprecated global presence channel (limited to 200 members by Ably), replaced by CHANNEL_COMPANY_PRESENCE */
 export declare const CHANNEL_PRESENCE_CLIENT = "pre:client";
 /** private: events of one session (code runs, requested data, client track commands) */
 export declare const CHANNEL_SESSION: (sessionId: string) => string;
@@ -16,6 +21,14 @@ export declare const CHANNEL_PROBLEM: (problemKey: string) => string;
 export declare const CHANNEL_CONTEST: (contestKey: string, role: ContestChannelRole) => string;
 /** system administrators only: data sent by a tracked client (screenshots, location, device) */
 export declare const CHANNEL_CLIENT_TRACK: (trackedClientId: ClientId) => string;
+/**
+ * presence of the clients (tabs) of the logged users of a company (by its key), data: `UserPresenceData`.
+ * The clients only enter (capability `presence`), only the administrators of the company receive it
+ * (capability `presence-subscribe`). Ably limits the presence members per channel (200 by default,
+ * more with server-side batching enabled on the `presence` namespace).
+ * The identity of a member is its `clientId` (`sessionId|uiId`, verified by Ably), never its data.
+ */
+export declare const CHANNEL_COMPANY_PRESENCE: (companyKey: string) => string;
 export declare const CHANNEL_SUBMISSION_ALL = "submission:*";
 export declare const CHANNEL_PROBLEM_ALL = "problem:*";
 export declare const CHANNEL_CLIENT_TRACK_ALL = "client-track:*";

package/dist/types/dto/socket.d.ts

@@ -8,6 +8,7 @@ interface WebsocketMessage {
 export interface PingWebSocketEventDTO extends WebsocketMessage {
     event: WebSocketMessageEvent.PING;
 }
+/** @deprecated the location is the `href` of the company presence (`UserPresenceData`) */
 export interface ClientTrackLocationWebSocketEventDTO extends WebsocketMessage {
     event: WebSocketMessageEvent.CLIENT_TRACK_LOCATION;
     href: string;
@@ -269,4 +270,12 @@ export interface WebSocketChannelsMessageDTO {
     channels: string[];
     event: WebSocketResponseEventDTO;
 }
+/**
+ * Data of a client (tab) in its company presence channel (`CHANNEL_COMPANY_PRESENCE`).
+ * Sent by the client: informative only, the identity is the presence member `clientId`.
+ */
+export interface UserPresenceData {
+    href: string;
+    uiId: string;
+}
 export {};

package/dist/types/types/socket.d.ts

@@ -6,6 +6,10 @@ export declare enum WebSocketMessageEvent {
     CLIENT_TRACK_DEVICE = "CLIENT_TRACK_DEVICE",
     CHAT_COMPLETIONS = "CHAT_COMPLETIONS"
 }
+/**
+ * Subscriptions of the client. With the TOPIC channels they are not sent to the server anymore:
+ * they only say which channel the client attaches (`getChannelOfWebSocketSubscribeEvent`) and the dispatch key.
+ */
 export declare enum WebSocketSubscriptionEvent {
     SUBSCRIBE_CODE_RUN_STATUS = "SUBSCRIBE_CODE_RUN_STATUS",
     UNSUBSCRIBE_CODE_RUN_STATUS = "UNSUBSCRIBE_CODE_RUN_STATUS",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juki-team/commons",
-  "version": "0.1.42",
+  "version": "0.1.43",
   "author": "juki-team",
   "license": "MIT",
   "type": "module",