@juki-team/commons 0.1.40 → 0.1.42

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

@@ -1,6 +1,28 @@
-import { ClientId } from '../types';
+import { ClientId, ContestChannelRole } from '../types';
 export declare const CHANNEL_PUBLISH_SUBSCRIPTIONS = "pub:subscriptions";
 export declare const CHANNEL_SUBSCRIBE_NOTIFICATIONS = "sub:notifications";
 export declare const CHANNEL_SUBSCRIBE_CLIENT: (clientId: ClientId) => string;
 export declare const CHANNEL_PUBLISH_MESSAGES = "pub:messages";
 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;
+/** private: events of one user (own submissions while the contest is frozen, notifications) */
+export declare const CHANNEL_USER: (userId: string) => string;
+/** public: status of a submission when it is visible to everyone */
+export declare const CHANNEL_SUBMISSION: (submitId: string) => string;
+/** public: changes of a problem */
+export declare const CHANNEL_PROBLEM: (problemKey: string) => string;
+/** per role: events of a contest for one role (and the roles above it, see `ContestChannelRole`) */
+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;
+export declare const CHANNEL_SUBMISSION_ALL = "submission:*";
+export declare const CHANNEL_PROBLEM_ALL = "problem:*";
+export declare const CHANNEL_CLIENT_TRACK_ALL = "client-track:*";
+/**
+ * Returns the contest and role of a `CHANNEL_CONTEST` channel name, or null if it is not one.
+ */
+export declare const getContestChannelParams: (channel: string) => {
+    contestKey: string;
+    role: ContestChannelRole;
+} | null;

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

@@ -94,8 +94,16 @@ export interface UnsubscribeUserNotificationWebSocketEventDTO extends WebsocketS
     event: WebSocketSubscriptionEvent.UNSUBSCRIBE_USER_NOTIFICATION;
     userKey: string;
 }
-export type WebSocketSubscribeEventDTO = SubscribeCodeRunStatusWebSocketEventDTO | SubscribeSubmissionRunStatusWebSocketEventDTO | SubscribeGetDataWebSocketEventDTO | SubscribeProblemCrawledWebSocketEventDTO | SubscribeSubmissionsCrawlWebSocketEventDTO | SubscribeContestChangesWebSocketEventDTO | SubscribeClientTrackWebSocketEventDTO | SubscribeUserNotificationWebsocketEventDTO;
-export type WebSocketUnsubscribeEventDTO = UnsubscribeCodeRunStatusWebSocketEventDTO | UnsubscribeSubmissionRunStatusWebSocketEventDTO | UnsubscribeGetDataWebSocketEventDTO | UnsubscribeProblemCrawledWebSocketEventDTO | UnsubscribeSubmissionsCrawlWebSocketEventDTO | UnsubscribeContestChangesWebSocketEventDTO | UnsubscribeClientTrackWebSocketEventDTO | UnsubscribeUserNotificationWebSocketEventDTO;
+export interface SubscribeClientTrackDataWebSocketEventDTO extends WebsocketSubscription {
+    event: WebSocketSubscriptionEvent.SUBSCRIBE_CLIENT_TRACK_DATA;
+    trackedClientId: ClientId;
+}
+export interface UnsubscribeClientTrackDataWebSocketEventDTO extends WebsocketSubscription {
+    event: WebSocketSubscriptionEvent.UNSUBSCRIBE_CLIENT_TRACK_DATA;
+    trackedClientId: ClientId;
+}
+export type WebSocketSubscribeEventDTO = SubscribeCodeRunStatusWebSocketEventDTO | SubscribeSubmissionRunStatusWebSocketEventDTO | SubscribeGetDataWebSocketEventDTO | SubscribeProblemCrawledWebSocketEventDTO | SubscribeSubmissionsCrawlWebSocketEventDTO | SubscribeContestChangesWebSocketEventDTO | SubscribeClientTrackWebSocketEventDTO | SubscribeUserNotificationWebsocketEventDTO | SubscribeClientTrackDataWebSocketEventDTO;
+export type WebSocketUnsubscribeEventDTO = UnsubscribeCodeRunStatusWebSocketEventDTO | UnsubscribeSubmissionRunStatusWebSocketEventDTO | UnsubscribeGetDataWebSocketEventDTO | UnsubscribeProblemCrawledWebSocketEventDTO | UnsubscribeSubmissionsCrawlWebSocketEventDTO | UnsubscribeContestChangesWebSocketEventDTO | UnsubscribeClientTrackWebSocketEventDTO | UnsubscribeUserNotificationWebSocketEventDTO | UnsubscribeClientTrackDataWebSocketEventDTO;
 export interface WebSocketResponse {
     event: WebSocketResponseEvent;
     key: WebSocketResponseEventKey;
@@ -253,4 +261,12 @@ export interface UserNotificationContestClarificationWebSocketResponseEventDTO e
     };
 }
 export type WebSocketResponseEventDTO = PongWebSocketResponseEventDTO | CodeRunStatusWebSocketResponseEventDTO | SubmissionRunStatusWebSocketResponseEventDTO | UserMessageWebSocketResponseEventDTO | SendDataEcsTaskDefinitionListWebSocketResponseEventDTO | SendDataEcsTasksListWebSocketResponseEventDTO | SendDataEc2InstancesListWebSocketResponseEventDTO | SendDataSsmSessionsListWebSocketResponseEventDTO | ProblemCrawledWebSocketResponseEventDTO | SendDataChatCompletionsWebSocketResponseEventDTO | SubmissionsCrawlWebSocketResponseEventDTO | ContestChangesWebSocketResponseEventDTO | SendDataRunCommandWebSocketResponseEventDTO | SendDataClientTrackWebSocketResponseEventDTO | ClientTrackWebSocketResponseEventDTO | UserNotificationSubmissionWebSocketResponseEventDTO | UserNotificationContestClarificationWebSocketResponseEventDTO;
+/**
+ * Message sent by the backend producers to the websocket SQS queue:
+ * the producer (trusted, with access to the DB) decides the Ably channels where the event is published.
+ */
+export interface WebSocketChannelsMessageDTO {
+    channels: string[];
+    event: WebSocketResponseEventDTO;
+}
 export {};

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

@@ -1,4 +1,4 @@
-import { ChatCompletionsWebSocketEventDTO, ClientTrackDeviceWebSocketEventDTO, ClientTrackLocationWebSocketEventDTO, ClientTrackScreenshotWebSocketEventDTO, ClientTrackWebSocketResponseEventDTO, CodeRunStatusWebSocketResponseEventDTO, ContestChangesWebSocketResponseEventDTO, PingWebSocketEventDTO, PongWebSocketResponseEventDTO, ProblemCrawledWebSocketResponseEventDTO, SendDataChatCompletionsWebSocketResponseEventDTO, SendDataClientTrackWebSocketResponseEventDTO, SendDataEc2InstancesListWebSocketResponseEventDTO, SendDataEcsTaskDefinitionListWebSocketResponseEventDTO, SendDataEcsTasksListWebSocketResponseEventDTO, SendDataRunCommandWebSocketResponseEventDTO, SendDataSsmSessionsListWebSocketResponseEventDTO, SendDataWebSocketResponseEventDTO, SubmissionRunStatusWebSocketResponseEventDTO, SubmissionsCrawlWebSocketResponseEventDTO, SubscribeClientTrackWebSocketEventDTO, SubscribeCodeRunStatusWebSocketEventDTO, SubscribeContestChangesWebSocketEventDTO, SubscribeGetDataWebSocketEventDTO, SubscribeProblemCrawledWebSocketEventDTO, SubscribeSubmissionRunStatusWebSocketEventDTO, SubscribeSubmissionsCrawlWebSocketEventDTO, SubscribeUserNotificationWebsocketEventDTO, UnsubscribeClientTrackWebSocketEventDTO, UnsubscribeCodeRunStatusWebSocketEventDTO, UnsubscribeContestChangesWebSocketEventDTO, UnsubscribeGetDataWebSocketEventDTO, UnsubscribeProblemCrawledWebSocketEventDTO, UnsubscribeSubmissionRunStatusWebSocketEventDTO, UnsubscribeSubmissionsCrawlWebSocketEventDTO, UnsubscribeUserNotificationWebSocketEventDTO, UserMessageWebSocketResponseEventDTO, UserNotificationContestClarificationWebSocketResponseEventDTO, UserNotificationSubmissionWebSocketResponseEventDTO, UserNotificationWebSocketResponseEventDTO, WebSocketMessageEventDTO, WebSocketResponseEventDTO, WebSocketSubscribeEventDTO, WebSocketUnsubscribeEventDTO } from '../dto';
+import { ChatCompletionsWebSocketEventDTO, ClientTrackDeviceWebSocketEventDTO, ClientTrackLocationWebSocketEventDTO, ClientTrackScreenshotWebSocketEventDTO, ClientTrackWebSocketResponseEventDTO, CodeRunStatusWebSocketResponseEventDTO, ContestChangesWebSocketResponseEventDTO, PingWebSocketEventDTO, PongWebSocketResponseEventDTO, ProblemCrawledWebSocketResponseEventDTO, SendDataChatCompletionsWebSocketResponseEventDTO, SendDataClientTrackWebSocketResponseEventDTO, SendDataEc2InstancesListWebSocketResponseEventDTO, SendDataEcsTaskDefinitionListWebSocketResponseEventDTO, SendDataEcsTasksListWebSocketResponseEventDTO, SendDataRunCommandWebSocketResponseEventDTO, SendDataSsmSessionsListWebSocketResponseEventDTO, SendDataWebSocketResponseEventDTO, SubmissionRunStatusWebSocketResponseEventDTO, SubmissionsCrawlWebSocketResponseEventDTO, SubscribeClientTrackDataWebSocketEventDTO, SubscribeClientTrackWebSocketEventDTO, SubscribeCodeRunStatusWebSocketEventDTO, SubscribeContestChangesWebSocketEventDTO, SubscribeGetDataWebSocketEventDTO, SubscribeProblemCrawledWebSocketEventDTO, SubscribeSubmissionRunStatusWebSocketEventDTO, SubscribeSubmissionsCrawlWebSocketEventDTO, SubscribeUserNotificationWebsocketEventDTO, UnsubscribeClientTrackDataWebSocketEventDTO, UnsubscribeClientTrackWebSocketEventDTO, UnsubscribeCodeRunStatusWebSocketEventDTO, UnsubscribeContestChangesWebSocketEventDTO, UnsubscribeGetDataWebSocketEventDTO, UnsubscribeProblemCrawledWebSocketEventDTO, UnsubscribeSubmissionRunStatusWebSocketEventDTO, UnsubscribeSubmissionsCrawlWebSocketEventDTO, UnsubscribeUserNotificationWebSocketEventDTO, UserMessageWebSocketResponseEventDTO, UserNotificationContestClarificationWebSocketResponseEventDTO, UserNotificationSubmissionWebSocketResponseEventDTO, UserNotificationWebSocketResponseEventDTO, WebSocketChannelsMessageDTO, WebSocketMessageEventDTO, WebSocketResponseEventDTO, WebSocketSubscribeEventDTO, WebSocketUnsubscribeEventDTO } from '../dto';
 import { ClientId, WebSocketResponseEvent, WebSocketResponseEventKey } from '../types';
 export declare const isWebsocketSubscription: (event: any) => event is WebSocketSubscribeEventDTO | WebSocketUnsubscribeEventDTO | WebSocketMessageEventDTO;
 export declare const isPingWebSocketEventDTO: (event: any) => event is PingWebSocketEventDTO;
@@ -22,6 +22,8 @@ export declare const isSubscribeClientTrackWebSocketEventDTO: (event: any) => ev
 export declare const isUnsubscribeClientTrackWebSocketEventDTO: (event: any) => event is UnsubscribeClientTrackWebSocketEventDTO;
 export declare const isSubscribeUserNotificationWebSocketEventDTO: (event: any) => event is SubscribeUserNotificationWebsocketEventDTO;
 export declare const isUnsubscribeUserNotificationWebSocketEventDTO: (event: any) => event is UnsubscribeUserNotificationWebSocketEventDTO;
+export declare const isSubscribeClientTrackDataWebSocketEventDTO: (event: any) => event is SubscribeClientTrackDataWebSocketEventDTO;
+export declare const isUnsubscribeClientTrackDataWebSocketEventDTO: (event: any) => event is UnsubscribeClientTrackDataWebSocketEventDTO;
 export declare const isWebSocketResponseEventDTO: (event: any) => event is WebSocketResponseEventDTO;
 export declare const isPongWebSocketResponseEventDTO: (event: any) => event is PongWebSocketResponseEventDTO;
 export declare const isCodeRunStatusMessageWebSocketResponseEventDTO: (event: any) => event is CodeRunStatusWebSocketResponseEventDTO;
@@ -43,3 +45,20 @@ export declare const isUserNotificationWebSocketResponseEventDTO: (event: any) =
 export declare const isUserNotificationSubmissionWebSocketResponseEventDTO: (event: any) => event is UserNotificationSubmissionWebSocketResponseEventDTO;
 export declare const isUserNotificationContestClarificationWebSocketResponseEventDTO: (event: any) => event is UserNotificationContestClarificationWebSocketResponseEventDTO;
 export declare const getWebSocketResponseEventKey: (event: WebSocketResponseEvent, clientId: ClientId, id: string) => WebSocketResponseEventKey;
+export declare const isWebSocketChannelsMessageDTO: (message: any) => message is WebSocketChannelsMessageDTO;
+/**
+ * Key used by the client to dispatch a response received on a TOPIC channel to its subscribers.
+ * It is the same key that `getKeyWebSocketEventDTO` (base-ui) computes for the subscription.
+ * Returns null when the response is not addressed to this client.
+ */
+export declare const getWebSocketResponseEventKeyOfResponse: (response: WebSocketResponseEventDTO, clientId: ClientId) => WebSocketResponseEventKey | null;
+/**
+ * TOPIC channel that the client has to attach to receive the events of a subscription,
+ * or null when the events arrive by the private channels (session / user) the client is always attached to.
+ * Ably rejects the attach if the token has no capability for the channel.
+ */
+export declare const getChannelOfWebSocketSubscribeEvent: (event: WebSocketSubscribeEventDTO) => string | null;
+/**
+ * Contest whose role channels the client needs (the API grants them when the token is requested with this contest).
+ */
+export declare const getContestKeyOfWebSocketSubscribeEvent: (event: WebSocketSubscribeEventDTO) => string | null;

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

@@ -22,7 +22,9 @@ export declare enum WebSocketSubscriptionEvent {
     SUBSCRIBE_CLIENT_TRACK = "SUBSCRIBE_CLIENT_TRACK",
     UNSUBSCRIBE_CLIENT_TRACK = "UNSUBSCRIBE_CLIENT_TRACK",
     SUBSCRIBE_USER_NOTIFICATION = "SUBSCRIBE_USER_NOTIFICATION",
-    UNSUBSCRIBE_USER_NOTIFICATION = "UNSUBSCRIBE_USER_NOTIFICATION"
+    UNSUBSCRIBE_USER_NOTIFICATION = "UNSUBSCRIBE_USER_NOTIFICATION",
+    SUBSCRIBE_CLIENT_TRACK_DATA = "SUBSCRIBE_CLIENT_TRACK_DATA",
+    UNSUBSCRIBE_CLIENT_TRACK_DATA = "UNSUBSCRIBE_CLIENT_TRACK_DATA"
 }
 export declare enum WebSocketResponseEvent {
     PONG = "PONG",
@@ -47,3 +49,16 @@ export declare enum WebSocketResponseEvent {
 }
 export type ClientId = `${RecordId}|${string}`;
 export type WebSocketResponseEventKey = `${WebSocketResponseEvent}-${ClientId}-${string}`;
+/**
+ * Roles of a contest, with the same names as the contest members in the DB.
+ * Each role has its own Ably channel: `contest:{contestKey}:{role}` (see `CHANNEL_CONTEST`).
+ * The inclusions follow `getContestAccessPermissions`:
+ *   spectators ⊇ managers ⊇ administrators, spectators ⊇ participants, spectators ⊇ guests
+ */
+export declare enum ContestChannelRole {
+    ADMINISTRATORS = "administrators",
+    MANAGERS = "managers",
+    PARTICIPANTS = "participants",
+    GUESTS = "guests",
+    SPECTATORS = "spectators"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juki-team/commons",
-  "version": "0.1.40",
+  "version": "0.1.42",
   "author": "juki-team",
   "license": "MIT",
   "type": "module",
@@ -17,22 +17,29 @@
   "files": [
     "dist"
   ],
-  "repository": "https://github.com/juki-team/commons.git",
-  "scripts": {
-    "docs": "typedoc src/index.ts",
-    "watch": "rollup -cw",
-    "build": "rm -rf docs && rm -rf dist && rollup -c && yarn docs",
-    "git:commit-push": "f() { param=${1}; message=${param:-chore}; echo ${message}; git add .; echo $message | git commit -F -; yarn publish --patch --no-git-tag-version; version=\"v$(node -p \"require('./package.json').version\")\"; git add .; echo $version | git commit -F -; git push origin main; echo $version | git tag -a $(echo $version) -F -; git push origin --tags; }; f",
-    "git:push": "f() { yarn publish --patch --no-git-tag-version; version=\"v$(node -p \"require('./package.json').version\")\"; git add .; echo $version | git commit -F -; git push origin main; echo $version | git tag -a $(echo $version) -F -; git push origin --tags; }; f",
-    "push-commit": "f() { yarn build && yarn git-push \"${1}\"; }; f",
-    "push": "yarn build && yarn git:push"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/juki-team/commons.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
   "devDependencies": {
-    "@types/uuid": "^11.0.0",
     "prettier": "^3.8.1",
     "rollup": "^4.57.1",
     "rollup-plugin-typescript2": "^0.36.0",
     "typedoc": "^0.28.16",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "uuid": "^13.0.0 || ^14.0.0"
+  },
+  "scripts": {
+    "docs": "typedoc src/index.ts",
+    "watch": "rollup -cw",
+    "build": "rm -rf docs && rm -rf dist && rollup -c && pnpm run docs",
+    "push-commit": "f() { git add -A && git commit -m \"${1:-chore}\" && pnpm push; }; f",
+    "push": "f() { pnpm version patch --no-git-tag-version --no-git-checks && pnpm build && pnpm publish --tag release-0.1 --no-git-checks && version=\"v$(node -p \"require('./package.json').version\")\" && git add -A && git commit -m $version && git tag -a $version -m $version && git push origin v0.1.x --follow-tags; }; f"
   }
-}
+}