@juki-team/commons 0.1.46 → 0.1.47

package/dist/cjs/index.cjs

@@ -641,7 +641,8 @@ exports.ProblemChannelRole = void 0;
     ProblemChannelRole["SPECTATORS"] = "spectators";
 })(exports.ProblemChannelRole || (exports.ProblemChannelRole = {}));
 /**
- * Roles of the public channels of a user: `user:{userId}:{role}` (see `CHANNEL_USER_ROLE`).
+ * Roles of the public channels of a user: `user:{userKey}:{role}` (see `CHANNEL_USER_ROLE`), by its public key
+ * (`getUserKey(nickname, organizationKey)`) like problems and contests.
  * There are no per-user permissions: `spectators` is everyone who can list the submissions of the user.
  * The private channel of the user is `user:{userId}` (see `CHANNEL_USER`).
  */
@@ -2258,8 +2259,12 @@ const segment = (value) => encodeURIComponent(value);
 const CHANNEL_SESSION = (sessionId) => `session:${segment(sessionId)}`;
 /** private: events of one user (own submissions while the contest is frozen, notifications, own problem crawls) */
 const CHANNEL_USER = (userId) => `user:${segment(userId)}`;
-/** per role: public events of one user (judging of its submissions visible to everyone, see `UserChannelRole`) */
-const CHANNEL_USER_ROLE = (userId, role) => `user:${segment(userId)}:${role}`;
+/**
+ * per role: public events of one user (judging of its submissions visible to everyone, see `UserChannelRole`).
+ * By its public key (`getUserKey(nickname, organizationKey)`), the one the clients know; the private channel
+ * (`CHANNEL_USER`) is by id. They never collide: the role channel has one more segment.
+ */
+const CHANNEL_USER_ROLE = (userKey, role) => `user:${segment(userKey)}:${role}`;
 /** public: status of a submission when it is visible to everyone */
 const CHANNEL_SUBMISSION = (submitId) => `submission:${segment(submitId)}`;
 /** per role: events of a problem for one role (judging of its submissions, see `ProblemChannelRole`) */
@@ -2276,7 +2281,7 @@ const CHANNEL_CONTEST = (contestKey, role) => `contest:${segment(contestKey)}:${
 const CHANNEL_ORGANIZATION_PRESENCE = (organizationKey) => `presence:organization:${segment(organizationKey)}`;
 // capability resources (wildcards) of the public channels.
 // Ably: a trailing `*` replaces one or more segments, any other `*` exactly one segment. So `user:*:spectators`
-// matches every `user:{userId}:spectators` but never the private `user:{userId}`.
+// matches every `user:{userKey}:spectators` but never the private `user:{userId}`.
 // There is no public `problem:*`: it would also match the role channels `problem:{problemKey}:{role}`.
 const CHANNEL_SUBMISSION_ALL = 'submission:*';
 const CHANNEL_USER_SPECTATORS_ALL = `user:*:${exports.UserChannelRole.SPECTATORS}`;
@@ -3013,10 +3018,10 @@ const isUnsubscribeUserNotificationWebSocketEventDto = (event) => {
 };
 const isNonEmptyString = (value) => typeof value === 'string' && !!value;
 /**
- * Exactly one of `problemKey` / `contestKey` / `userId` is set.
+ * Exactly one of `problemKey` / `contestKey` / `userKey` is set.
  */
 const isSubmissionsJudgingScope = (scope) => {
-    return [scope?.problemKey, scope?.contestKey, scope?.userId].filter(isNonEmptyString).length === 1;
+    return [scope?.problemKey, scope?.contestKey, scope?.userKey].filter(isNonEmptyString).length === 1;
 };
 const isSubscribeSubmissionsJudgingWebSocketEventDto = (event) => {
     return isWebsocketSubscription(event)
@@ -3055,7 +3060,7 @@ const isSubmissionJudgingWebSocketResponseEventDto = (event) => {
         && isNonEmptyString(event?.submitId)
         && isNonEmptyString(event?.problemKey)
         && (event?.contestKey === null || isNonEmptyString(event?.contestKey))
-        && isNonEmptyString(event?.userId)
+        && isNonEmptyString(event?.userKey)
         && typeof event?.judging === 'boolean'
         && event?.status in exports.SubmissionRunStatus
         && event?.verdict in exports.ProblemVerdict
@@ -3195,8 +3200,8 @@ const getChannelOfWebSocketSubscribeEvent = (event) => {
         if ('contestKey' in event && event.contestKey) {
             return CHANNEL_CONTEST(event.contestKey, exports.ContestChannelRole.SPECTATORS);
         }
-        if ('userId' in event && event.userId) {
-            return CHANNEL_USER_ROLE(event.userId, exports.UserChannelRole.SPECTATORS);
+        if ('userKey' in event && event.userKey) {
+            return CHANNEL_USER_ROLE(event.userKey, exports.UserChannelRole.SPECTATORS);
         }
     }
     return null;

package/dist/esm/index.js

@@ -639,7 +639,8 @@ var ProblemChannelRole;
     ProblemChannelRole["SPECTATORS"] = "spectators";
 })(ProblemChannelRole || (ProblemChannelRole = {}));
 /**
- * Roles of the public channels of a user: `user:{userId}:{role}` (see `CHANNEL_USER_ROLE`).
+ * Roles of the public channels of a user: `user:{userKey}:{role}` (see `CHANNEL_USER_ROLE`), by its public key
+ * (`getUserKey(nickname, organizationKey)`) like problems and contests.
  * There are no per-user permissions: `spectators` is everyone who can list the submissions of the user.
  * The private channel of the user is `user:{userId}` (see `CHANNEL_USER`).
  */
@@ -2256,8 +2257,12 @@ const segment = (value) => encodeURIComponent(value);
 const CHANNEL_SESSION = (sessionId) => `session:${segment(sessionId)}`;
 /** private: events of one user (own submissions while the contest is frozen, notifications, own problem crawls) */
 const CHANNEL_USER = (userId) => `user:${segment(userId)}`;
-/** per role: public events of one user (judging of its submissions visible to everyone, see `UserChannelRole`) */
-const CHANNEL_USER_ROLE = (userId, role) => `user:${segment(userId)}:${role}`;
+/**
+ * per role: public events of one user (judging of its submissions visible to everyone, see `UserChannelRole`).
+ * By its public key (`getUserKey(nickname, organizationKey)`), the one the clients know; the private channel
+ * (`CHANNEL_USER`) is by id. They never collide: the role channel has one more segment.
+ */
+const CHANNEL_USER_ROLE = (userKey, role) => `user:${segment(userKey)}:${role}`;
 /** public: status of a submission when it is visible to everyone */
 const CHANNEL_SUBMISSION = (submitId) => `submission:${segment(submitId)}`;
 /** per role: events of a problem for one role (judging of its submissions, see `ProblemChannelRole`) */
@@ -2274,7 +2279,7 @@ const CHANNEL_CONTEST = (contestKey, role) => `contest:${segment(contestKey)}:${
 const CHANNEL_ORGANIZATION_PRESENCE = (organizationKey) => `presence:organization:${segment(organizationKey)}`;
 // capability resources (wildcards) of the public channels.
 // Ably: a trailing `*` replaces one or more segments, any other `*` exactly one segment. So `user:*:spectators`
-// matches every `user:{userId}:spectators` but never the private `user:{userId}`.
+// matches every `user:{userKey}:spectators` but never the private `user:{userId}`.
 // There is no public `problem:*`: it would also match the role channels `problem:{problemKey}:{role}`.
 const CHANNEL_SUBMISSION_ALL = 'submission:*';
 const CHANNEL_USER_SPECTATORS_ALL = `user:*:${UserChannelRole.SPECTATORS}`;
@@ -3011,10 +3016,10 @@ const isUnsubscribeUserNotificationWebSocketEventDto = (event) => {
 };
 const isNonEmptyString = (value) => typeof value === 'string' && !!value;
 /**
- * Exactly one of `problemKey` / `contestKey` / `userId` is set.
+ * Exactly one of `problemKey` / `contestKey` / `userKey` is set.
  */
 const isSubmissionsJudgingScope = (scope) => {
-    return [scope?.problemKey, scope?.contestKey, scope?.userId].filter(isNonEmptyString).length === 1;
+    return [scope?.problemKey, scope?.contestKey, scope?.userKey].filter(isNonEmptyString).length === 1;
 };
 const isSubscribeSubmissionsJudgingWebSocketEventDto = (event) => {
     return isWebsocketSubscription(event)
@@ -3053,7 +3058,7 @@ const isSubmissionJudgingWebSocketResponseEventDto = (event) => {
         && isNonEmptyString(event?.submitId)
         && isNonEmptyString(event?.problemKey)
         && (event?.contestKey === null || isNonEmptyString(event?.contestKey))
-        && isNonEmptyString(event?.userId)
+        && isNonEmptyString(event?.userKey)
         && typeof event?.judging === 'boolean'
         && event?.status in SubmissionRunStatus
         && event?.verdict in ProblemVerdict
@@ -3193,8 +3198,8 @@ const getChannelOfWebSocketSubscribeEvent = (event) => {
         if ('contestKey' in event && event.contestKey) {
             return CHANNEL_CONTEST(event.contestKey, ContestChannelRole.SPECTATORS);
         }
-        if ('userId' in event && event.userId) {
-            return CHANNEL_USER_ROLE(event.userId, UserChannelRole.SPECTATORS);
+        if ('userKey' in event && event.userKey) {
+            return CHANNEL_USER_ROLE(event.userKey, UserChannelRole.SPECTATORS);
         }
     }
     return null;

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

@@ -3,8 +3,12 @@ import { ContestChannelRole, ProblemChannelRole, UserChannelRole } from '../type
 export declare const CHANNEL_SESSION: (sessionId: string) => string;
 /** private: events of one user (own submissions while the contest is frozen, notifications, own problem crawls) */
 export declare const CHANNEL_USER: (userId: string) => string;
-/** per role: public events of one user (judging of its submissions visible to everyone, see `UserChannelRole`) */
-export declare const CHANNEL_USER_ROLE: (userId: string, role: UserChannelRole) => string;
+/**
+ * per role: public events of one user (judging of its submissions visible to everyone, see `UserChannelRole`).
+ * By its public key (`getUserKey(nickname, organizationKey)`), the one the clients know; the private channel
+ * (`CHANNEL_USER`) is by id. They never collide: the role channel has one more segment.
+ */
+export declare const CHANNEL_USER_ROLE: (userKey: string, role: UserChannelRole) => string;
 /** public: status of a submission when it is visible to everyone */
 export declare const CHANNEL_SUBMISSION: (submitId: string) => string;
 /** per role: events of a problem for one role (judging of its submissions, see `ProblemChannelRole`) */

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

@@ -72,7 +72,7 @@ export type SubmissionsJudgingScope = {
 } | {
     contestKey: string;
 } | {
-    userId: string;
+    userKey: string;
 };
 export type SubscribeSubmissionsJudgingWebSocketEventDto = WebsocketSubscription & {
     event: WebSocketSubscriptionEvent.SUBSCRIBE_SUBMISSIONS_JUDGING;
@@ -114,7 +114,7 @@ export interface SubmissionJudgingWebSocketResponseEventDto extends WebSocketRes
     submitId: string;
     problemKey: string;
     contestKey: string | null;
-    userId: string;
+    userKey: string;
     judging: boolean;
     status: SubmissionRunStatus;
     verdict: ProblemVerdict;

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

@@ -16,7 +16,7 @@ export declare const isUnsubscribeContestChangesWebSocketEventDto: (event: any)
 export declare const isSubscribeUserNotificationWebSocketEventDto: (event: any) => event is SubscribeUserNotificationWebsocketEventDto;
 export declare const isUnsubscribeUserNotificationWebSocketEventDto: (event: any) => event is UnsubscribeUserNotificationWebSocketEventDto;
 /**
- * Exactly one of `problemKey` / `contestKey` / `userId` is set.
+ * Exactly one of `problemKey` / `contestKey` / `userKey` is set.
  */
 export declare const isSubmissionsJudgingScope: (scope: any) => scope is SubmissionsJudgingScope;
 export declare const isSubscribeSubmissionsJudgingWebSocketEventDto: (event: any) => event is SubscribeSubmissionsJudgingWebSocketEventDto;

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

@@ -64,7 +64,8 @@ export declare enum ProblemChannelRole {
     SPECTATORS = "spectators"
 }
 /**
- * Roles of the public channels of a user: `user:{userId}:{role}` (see `CHANNEL_USER_ROLE`).
+ * Roles of the public channels of a user: `user:{userKey}:{role}` (see `CHANNEL_USER_ROLE`), by its public key
+ * (`getUserKey(nickname, organizationKey)`) like problems and contests.
  * There are no per-user permissions: `spectators` is everyone who can list the submissions of the user.
  * The private channel of the user is `user:{userId}` (see `CHANNEL_USER`).
  */

package/package.json

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