@juki-team/commons 0.1.46 → 0.1.48

package/dist/constants/services.js

@@ -0,0 +1,157 @@
+import { ErrorCode } from '../types/index.js';
+export const ERROR = {
+    // Http Errors
+    [ErrorCode.ERR500]: { value: ErrorCode.ERR500, message: 'internal server error', status: 500 },
+    [ErrorCode.ERR400]: { value: ErrorCode.ERR400, message: 'bad request', status: 400 },
+    [ErrorCode.ERR401]: { value: ErrorCode.ERR401, message: 'unauthorized', status: 401 },
+    [ErrorCode.ERR403]: { value: ErrorCode.ERR403, message: 'forbidden', status: 403 },
+    [ErrorCode.ERR404]: { value: ErrorCode.ERR404, message: 'not found', status: 404 },
+    [ErrorCode.ERR405]: { value: ErrorCode.ERR405, message: 'method not allowed', status: 405 },
+    // UI general errors
+    [ErrorCode.ERR9997]: { value: ErrorCode.ERR9997, message: 'aborted request', status: 400 },
+    [ErrorCode.ERR9998]: { value: ErrorCode.ERR9998, message: 'error on response', status: 400 },
+    [ErrorCode.ERR9999]: { value: ErrorCode.ERR9999, message: 'service no found', status: 400 },
+    // ORGANIZATION ERRORS ERR99XX
+    [ErrorCode.ERR9900]: { value: ErrorCode.ERR9900, message: 'internal server error on organization service', status: 500 },
+    // Organization server errors
+    [ErrorCode.ERR9910]: { value: ErrorCode.ERR9910, message: 'organization not created', status: 500 },
+    [ErrorCode.ERR9911]: { value: ErrorCode.ERR9911, message: 'organization not found', status: 500 },
+    [ErrorCode.ERR9912]: { value: ErrorCode.ERR9912, message: 'organization not updated', status: 500 },
+    [ErrorCode.ERR9913]: { value: ErrorCode.ERR9913, message: 'organization not deleted', status: 500 },
+    // Organization user permission error
+    [ErrorCode.ERR9914]: { value: ErrorCode.ERR9914, message: 'not allowed to create the organization', status: 400 },
+    [ErrorCode.ERR9915]: { value: ErrorCode.ERR9915, message: 'not allowed to view the organization', status: 400 },
+    [ErrorCode.ERR9916]: { value: ErrorCode.ERR9916, message: 'not allowed to updated the organization', status: 400 },
+    [ErrorCode.ERR9917]: { value: ErrorCode.ERR9917, message: 'not allowed to deleted the organization', status: 400 },
+    // USER ERRORS ERR00XX
+    [ErrorCode.ERR0000]: { value: ErrorCode.ERR0000, message: 'internal server error on users service', status: 500 },
+    // User server errors
+    [ErrorCode.ERR0010]: { value: ErrorCode.ERR0010, message: 'user not created', status: 500 },
+    [ErrorCode.ERR0011]: { value: ErrorCode.ERR0011, message: 'user not found', status: 500 },
+    [ErrorCode.ERR0012]: { value: ErrorCode.ERR0012, message: 'user not updated', status: 500 },
+    [ErrorCode.ERR0013]: { value: ErrorCode.ERR0013, message: 'user not deleted', status: 500 },
+    // User user permission error
+    [ErrorCode.ERR0014]: { value: ErrorCode.ERR0014, message: 'not allowed to create the user', status: 400 },
+    [ErrorCode.ERR0015]: { value: ErrorCode.ERR0015, message: 'not allowed to view the user', status: 400 },
+    [ErrorCode.ERR0016]: { value: ErrorCode.ERR0016, message: 'not allowed to updated the user', status: 400 },
+    [ErrorCode.ERR0017]: { value: ErrorCode.ERR0017, message: 'not allowed to deleted the user', status: 400 },
+    // User status permissions errors
+    [ErrorCode.ERR0018]: { value: ErrorCode.ERR0018, message: 'user is reported', status: 400 },
+    [ErrorCode.ERR0019]: { value: ErrorCode.ERR0019, message: 'user is archived', status: 400 },
+    // User others permissions errors
+    [ErrorCode.ERR0020]: { value: ErrorCode.ERR0020, message: 'user with email requested not found', status: 400 },
+    [ErrorCode.ERR0021]: { value: ErrorCode.ERR0021, message: 'user with nickname requested not found', status: 400 },
+    [ErrorCode.ERR0022]: { value: ErrorCode.ERR0022, message: 'the email is already registered', status: 400 },
+    [ErrorCode.ERR0023]: { value: ErrorCode.ERR0023, message: 'the nickname is already taken', status: 400 },
+    [ErrorCode.ERR0024]: { value: ErrorCode.ERR0024, message: 'incorrect password', status: 400 },
+    // User sessions errors
+    [ErrorCode.ERR0050]: { value: ErrorCode.ERR0050, message: 'user session not created', status: 500 },
+    [ErrorCode.ERR0051]: { value: ErrorCode.ERR0051, message: 'user session not found', status: 500 },
+    [ErrorCode.ERR0052]: { value: ErrorCode.ERR0052, message: 'user session not updated', status: 500 },
+    [ErrorCode.ERR0053]: { value: ErrorCode.ERR0053, message: 'user session not deleted', status: 500 },
+    // PROBLEM ERRORS ERR01XX
+    [ErrorCode.ERR0100]: { value: ErrorCode.ERR0100, message: 'internal server error on problems service', status: 500 },
+    // Problem server errors
+    [ErrorCode.ERR0110]: { value: ErrorCode.ERR0110, message: 'problem not created', status: 500 },
+    [ErrorCode.ERR0111]: { value: ErrorCode.ERR0111, message: 'problem not found', status: 500 },
+    [ErrorCode.ERR0112]: { value: ErrorCode.ERR0112, message: 'problem not updated', status: 500 },
+    [ErrorCode.ERR0113]: { value: ErrorCode.ERR0113, message: 'problem not deleted', status: 500 },
+    // Problem user permission error
+    [ErrorCode.ERR0114]: { value: ErrorCode.ERR0114, message: 'not allowed to create the problem', status: 400 },
+    [ErrorCode.ERR0115]: { value: ErrorCode.ERR0115, message: 'not allowed to view the problem', status: 400 },
+    [ErrorCode.ERR0116]: { value: ErrorCode.ERR0116, message: 'not allowed to updated the problem', status: 400 },
+    [ErrorCode.ERR0117]: { value: ErrorCode.ERR0117, message: 'not allowed to deleted the problem', status: 400 },
+    // Problem others permissions errors
+    [ErrorCode.ERR0118]: { value: ErrorCode.ERR0118, message: 'problem mode not supported', status: 500 },
+    [ErrorCode.ERR0119]: { value: ErrorCode.ERR0119, message: 'problem type not supported', status: 500 },
+    [ErrorCode.ERR0120]: { value: ErrorCode.ERR0120, message: 'problem time limit must be a number', status: 500 },
+    [ErrorCode.ERR0121]: { value: ErrorCode.ERR0121, message: 'problem memory limit must be number', status: 500 },
+    [ErrorCode.ERR0122]: { value: ErrorCode.ERR0122, message: 'test case file empty', status: 400 },
+    // Contest Errors ERR02XX
+    [ErrorCode.ERR0200]: { value: ErrorCode.ERR0200, message: 'internal server error on contests service', status: 500 },
+    // Contest Server Error
+    [ErrorCode.ERR0210]: { value: ErrorCode.ERR0210, message: 'contest not created', status: 500 },
+    [ErrorCode.ERR0211]: { value: ErrorCode.ERR0211, message: 'contest not found', status: 500 },
+    [ErrorCode.ERR0212]: { value: ErrorCode.ERR0212, message: 'contest not updated', status: 500 },
+    [ErrorCode.ERR0213]: { value: ErrorCode.ERR0213, message: 'contest not deleted', status: 500 },
+    // Contest User Permission error
+    [ErrorCode.ERR0214]: { value: ErrorCode.ERR0214, message: 'not allowed to create the contest', status: 400 },
+    [ErrorCode.ERR0215]: { value: ErrorCode.ERR0215, message: 'not allowed to view the contest', status: 400 },
+    [ErrorCode.ERR0216]: { value: ErrorCode.ERR0216, message: 'not allowed to updated the contest', status: 400 },
+    [ErrorCode.ERR0217]: { value: ErrorCode.ERR0217, message: 'not allowed to deleted the contest', status: 400 },
+    // Contest Others permissions errors
+    [ErrorCode.ERR0218]: { value: ErrorCode.ERR0218, message: 'not allowed to register to the contest', status: 400 },
+    [ErrorCode.ERR0219]: { value: ErrorCode.ERR0219, message: 'is already registered', status: 400 },
+    [ErrorCode.ERR0220]: { value: ErrorCode.ERR0220, message: 'not allowed to view contests', status: 400 },
+    [ErrorCode.ERR0230]: { value: ErrorCode.ERR0230, message: 'scoreboard not created', status: 500 },
+    [ErrorCode.ERR0231]: { value: ErrorCode.ERR0231, message: 'scoreboard not found', status: 500 },
+    [ErrorCode.ERR0232]: { value: ErrorCode.ERR0232, message: 'scoreboard not updated', status: 500 },
+    [ErrorCode.ERR0233]: { value: ErrorCode.ERR0233, message: 'scoreboard not deleted', status: 500 },
+    [ErrorCode.ERR0234]: { value: ErrorCode.ERR0234, message: 'not allowed to create the scoreboard', status: 400 },
+    [ErrorCode.ERR0235]: { value: ErrorCode.ERR0235, message: 'not allowed to view the scoreboard', status: 400 },
+    [ErrorCode.ERR0236]: { value: ErrorCode.ERR0236, message: 'not allowed to update the scoreboard', status: 400 },
+    [ErrorCode.ERR0237]: { value: ErrorCode.ERR0237, message: 'not allowed to delete the scoreboard', status: 400 },
+    [ErrorCode.ERR0240]: { value: ErrorCode.ERR0240, message: 'clarification not created', status: 500 },
+    [ErrorCode.ERR0241]: { value: ErrorCode.ERR0241, message: 'clarification not found', status: 500 },
+    [ErrorCode.ERR0242]: { value: ErrorCode.ERR0242, message: 'clarification not updated', status: 500 },
+    [ErrorCode.ERR0243]: { value: ErrorCode.ERR0243, message: 'clarification not deleted', status: 500 },
+    [ErrorCode.ERR0244]: { value: ErrorCode.ERR0244, message: 'not allowed to submit clarification', status: 400 },
+    [ErrorCode.ERR0245]: { value: ErrorCode.ERR0245, message: 'not allowed to view clarification', status: 400 },
+    [ErrorCode.ERR0246]: { value: ErrorCode.ERR0246, message: 'not allowed to update clarification', status: 400 },
+    [ErrorCode.ERR0247]: { value: ErrorCode.ERR0247, message: 'not allowed to delete clarification', status: 400 },
+    // Submission Errors ERR03XXX
+    [ErrorCode.ERR0300]: {
+        value: ErrorCode.ERR0300,
+        message: 'internal server error on submissions service',
+        status: 500,
+    },
+    [ErrorCode.ERR0301]: { value: ErrorCode.ERR0301, message: 'submission not found', status: 500 },
+    [ErrorCode.ERR0302]: { value: ErrorCode.ERR0302, message: 'submission not created', status: 500 },
+    [ErrorCode.ERR0303]: { value: ErrorCode.ERR0303, message: 'submission not updated', status: 500 },
+    [ErrorCode.ERR0310]: { value: ErrorCode.ERR0310, message: 'source empty', status: 400 },
+    [ErrorCode.ERR0311]: { value: ErrorCode.ERR0311, message: 'programming language not supported', status: 400 },
+    [ErrorCode.ERR0321]: {
+        value: ErrorCode.ERR0321,
+        message: 'not allowed submit the problem in the contest',
+        status: 400,
+    },
+    [ErrorCode.ERR0331]: { value: ErrorCode.ERR0331, message: 'judgement unavailable', status: 400 },
+    // Utils Errors ERR04XX
+    [ErrorCode.ERR0400]: { value: ErrorCode.ERR0400, message: 'internal server error on utils services', status: 500 },
+    [ErrorCode.ERR0410]: { value: ErrorCode.ERR0410, message: 'empty image', status: 400 },
+    [ErrorCode.ERR0420]: { value: ErrorCode.ERR0420, message: '', status: 400 }, // codes
+    [ErrorCode.ERR0421]: { value: ErrorCode.ERR0421, message: 'compilation failed', status: 400 }, // codes
+    [ErrorCode.ERR0430]: { value: ErrorCode.ERR0430, message: '', status: 400 }, // files
+    [ErrorCode.ERR0440]: { value: ErrorCode.ERR0440, message: 'the email could not be sent', status: 400 }, // mails
+    // TEAMS ERRORS ERR06XX
+    [ErrorCode.ERR0600]: { value: ErrorCode.ERR0600, message: 'internal server error on teams service', status: 500 },
+    // Teams server errors
+    [ErrorCode.ERR0610]: { value: ErrorCode.ERR0610, message: 'team not created', status: 400 },
+    [ErrorCode.ERR0611]: { value: ErrorCode.ERR0611, message: 'team not found', status: 400 },
+    [ErrorCode.ERR0612]: { value: ErrorCode.ERR0612, message: 'team not updated', status: 400 },
+    [ErrorCode.ERR0613]: { value: ErrorCode.ERR0613, message: 'team not deleted', status: 400 },
+    // Teams user permission error
+    [ErrorCode.ERR0614]: { value: ErrorCode.ERR0614, message: 'not allowed to create the team', status: 400 },
+    [ErrorCode.ERR0615]: { value: ErrorCode.ERR0615, message: 'not allowed to view the team', status: 400 },
+    [ErrorCode.ERR0616]: { value: ErrorCode.ERR0616, message: 'not allowed to updated the team', status: 400 },
+    [ErrorCode.ERR0617]: { value: ErrorCode.ERR0617, message: 'not allowed to deleted the team', status: 400 },
+    // Teams status permission error
+    [ErrorCode.ERR0618]: { value: ErrorCode.ERR0618, message: 'team is reported', status: 400 },
+    [ErrorCode.ERR0619]: { value: ErrorCode.ERR0619, message: 'team is archived', status: 400 },
+    // FILES ERRORS ERR08XX
+    [ErrorCode.ERR0800]: { value: ErrorCode.ERR0800, message: 'internal server error on files service', status: 500 },
+    // Files server errors
+    [ErrorCode.ERR0810]: { value: ErrorCode.ERR0810, message: 'file not created', status: 400 },
+    [ErrorCode.ERR0811]: { value: ErrorCode.ERR0811, message: 'file not found', status: 400 },
+    [ErrorCode.ERR0812]: { value: ErrorCode.ERR0812, message: 'file not updated', status: 400 },
+    [ErrorCode.ERR0813]: { value: ErrorCode.ERR0813, message: 'file not deleted', status: 400 },
+    // Files user permission error
+    [ErrorCode.ERR0814]: { value: ErrorCode.ERR0814, message: 'not allowed to create the file', status: 400 },
+    [ErrorCode.ERR0815]: { value: ErrorCode.ERR0815, message: 'not allowed to view the file', status: 400 },
+    [ErrorCode.ERR0816]: { value: ErrorCode.ERR0816, message: 'not allowed to updated the file', status: 400 },
+    [ErrorCode.ERR0817]: { value: ErrorCode.ERR0817, message: 'not allowed to deleted the file', status: 400 },
+    // Files status permission error
+    [ErrorCode.ERR0818]: { value: ErrorCode.ERR0818, message: 'file is reserved', status: 400 },
+    [ErrorCode.ERR0819]: { value: ErrorCode.ERR0819, message: 'file is private', status: 400 },
+    [ErrorCode.ERR0820]: { value: ErrorCode.ERR0820, message: 'file is archived', status: 400 },
+};

package/dist/{types/constants → constants}/system.d.ts

@@ -1,4 +1,4 @@
-import { SystemRole } from '../types';
+import { SystemRole } from '../types/index.js';
 export declare const SYSTEM_ROLE: {
     [key in SystemRole]: {
         value: SystemRole;

package/dist/constants/system.js

@@ -0,0 +1,9 @@
+import { SystemRole } from '../types/index.js';
+export const SYSTEM_ROLE = {
+    [SystemRole.GUEST]: { value: SystemRole.GUEST, label: 'guest', level: 5 },
+    [SystemRole.REGULAR]: { value: SystemRole.REGULAR, label: 'regular', level: 4 },
+    [SystemRole.MANAGER]: { value: SystemRole.MANAGER, label: 'manager', level: 3 },
+    [SystemRole.MASTER]: { value: SystemRole.MASTER, label: 'master', level: 2 },
+    [SystemRole.ADMIN]: { value: SystemRole.ADMIN, label: 'admin', level: 1 },
+    [SystemRole.SUPER_ADMIN]: { value: SystemRole.SUPER_ADMIN, label: 'super admin', level: 0 },
+};

package/dist/{types/constants → constants}/teams.d.ts

@@ -1,4 +1,4 @@
-import { MemberRole, TeamRole } from '../types';
+import { MemberRole, TeamRole } from '../types/index.js';
 export declare const MEMBER_ROLE: {
     [key in MemberRole]: {
         value: MemberRole;

package/dist/constants/teams.js

@@ -0,0 +1,17 @@
+import { MemberRole, TeamRole } from '../types/index.js';
+export const MEMBER_ROLE = {
+    [MemberRole.COACH]: { value: MemberRole.COACH, label: 'coach' },
+    [MemberRole.CO_COACH]: { value: MemberRole.CO_COACH, label: 'co-coach' },
+    [MemberRole.STAFF]: { value: MemberRole.STAFF, label: 'staff' },
+    [MemberRole.ATTENDEE]: { value: MemberRole.ATTENDEE, label: 'attendee' },
+    [MemberRole.RESERVE]: { value: MemberRole.RESERVE, label: 'reserve' },
+    [MemberRole.CONTESTANT]: { value: MemberRole.CONTESTANT, label: 'contestant' },
+};
+export const TEAM_ROLE = {
+    [TeamRole.RESTRICTED]: { value: TeamRole.RESTRICTED, label: 'restricted', level: 5 },
+    [TeamRole.GUEST]: { value: TeamRole.GUEST, label: 'guest', level: 4 },
+    [TeamRole.REGULAR]: { value: TeamRole.REGULAR, label: 'regular', level: 3 },
+    [TeamRole.MANAGER]: { value: TeamRole.MANAGER, label: 'manager', level: 2 },
+    [TeamRole.ADMIN]: { value: TeamRole.ADMIN, label: 'admin', level: 1 },
+    [TeamRole.SUPER_ADMIN]: { value: TeamRole.SUPER_ADMIN, label: 'super admin', level: 0 },
+};

package/dist/constants/time.js

@@ -0,0 +1,9 @@
+export const ONE_SECOND = 1000;
+export const SEC_30 = ONE_SECOND * 30;
+export const SEC_60 = ONE_SECOND * 60;
+export const SEC_90 = ONE_SECOND * 90;
+export const SEC_120 = ONE_SECOND * 120;
+export const ONE_MINUTE = ONE_SECOND * 60;
+export const ONE_HOUR = ONE_MINUTE * 60;
+export const ONE_DAY = ONE_HOUR * 24;
+export const ONE_WEEK = ONE_DAY * 7;

package/dist/{types/constants → constants}/user.d.ts

@@ -1,5 +1,5 @@
-import { UserPermissions } from '../dto';
-import { UserRole, UserStatus } from '../types';
+import { UserPermissions } from '../dto/index.js';
+import { UserRole, UserStatus } from '../types/index.js';
 export declare const USER_STATUS: {
     [key in UserStatus]: {
         value: UserStatus;

package/dist/constants/user.js

@@ -0,0 +1,40 @@
+import { UserRole, UserStatus } from '../types/index.js';
+export const USER_STATUS = {
+    [UserStatus.ACTIVE]: { value: UserStatus.ACTIVE, label: 'active' },
+    [UserStatus.REPORTED]: { value: UserStatus.REPORTED, label: 'reported' },
+    [UserStatus.ARCHIVED]: { value: UserStatus.ARCHIVED, label: 'archived' },
+};
+export const USER_ROLE = {
+    [UserRole.RESTRICTED]: { value: UserRole.RESTRICTED, label: 'restricted', level: 6 },
+    [UserRole.GUEST]: { value: UserRole.GUEST, label: 'guest', level: 5 },
+    [UserRole.LIMITED]: { value: UserRole.LIMITED, label: 'limited', level: 4 },
+    [UserRole.REGULAR]: { value: UserRole.REGULAR, label: 'regular', level: 3 },
+    [UserRole.MANAGER]: { value: UserRole.MANAGER, label: 'manager', level: 2 },
+    [UserRole.ADMIN]: { value: UserRole.ADMIN, label: 'admin', level: 1 },
+    [UserRole.SUPER_ADMIN]: { value: UserRole.SUPER_ADMIN, label: 'super admin', level: 0 },
+};
+export const EMPTY_USER_PERMISSIONS = {
+    users: {
+        create: false,
+        manage: false,
+        administrate: false,
+    },
+    problems: {
+        create: false,
+        manage: false,
+    },
+    submissions: {
+        manage: false,
+    },
+    contests: {
+        create: false,
+        manage: false,
+    },
+    organization: {
+        manage: false,
+        administrate: false,
+    },
+    services: {
+        administrate: false,
+    },
+};

package/dist/{types/constants → constants}/websocket.d.ts

@@ -1,10 +1,14 @@
-import { ContestChannelRole, ProblemChannelRole, UserChannelRole } from '../types';
+import { ContestChannelRole, ProblemChannelRole, UserChannelRole } from '../types/index.js';
 /** private: events of one session (code runs, requested data) */
 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/constants/websocket.js

@@ -0,0 +1,56 @@
+import { ContestChannelRole, ProblemChannelRole, UserChannelRole } from '../types/index.js';
+// TOPIC channels
+// The backend publishes each event once on the channel of its topic and Ably does the fan-out.
+// Who can subscribe to each channel is decided by the API in the Ably token (capability), never by the client.
+// Dynamic segments are encoded so a key can never inject a `:` (the Ably segment separator used by the wildcards).
+const segment = (value) => encodeURIComponent(value);
+/** private: events of one session (code runs, requested data) */
+export const CHANNEL_SESSION = (sessionId) => `session:${segment(sessionId)}`;
+/** private: events of one user (own submissions while the contest is frozen, notifications, own problem crawls) */
+export const CHANNEL_USER = (userId) => `user:${segment(userId)}`;
+/**
+ * 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 const CHANNEL_USER_ROLE = (userKey, role) => `user:${segment(userKey)}:${role}`;
+/** public: status of a submission when it is visible to everyone */
+export const CHANNEL_SUBMISSION = (submitId) => `submission:${segment(submitId)}`;
+/** per role: events of a problem for one role (judging of its submissions, see `ProblemChannelRole`) */
+export const CHANNEL_PROBLEM = (problemKey, role) => `problem:${segment(problemKey)}:${role}`;
+/** per role: events of a contest for one role (and the roles above it, see `ContestChannelRole`) */
+export const CHANNEL_CONTEST = (contestKey, role) => `contest:${segment(contestKey)}:${role}`;
+/**
+ * presence of the clients (tabs) of the logged users of a organization (by its key), data: `UserPresenceData`.
+ * The clients only enter (capability `presence`), only the administrators of the organization 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 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:{userKey}:spectators` but never the private `user:{userId}`.
+// There is no public `problem:*`: it would also match the role channels `problem:{problemKey}:{role}`.
+export const CHANNEL_SUBMISSION_ALL = 'submission:*';
+export const CHANNEL_USER_SPECTATORS_ALL = `user:*:${UserChannelRole.SPECTATORS}`;
+/**
+ * Returns the contest and role of a `CHANNEL_CONTEST` channel name, or null if it is not one.
+ */
+export const getContestChannelParams = (channel) => {
+    const [namespace, contestKey, role, ...rest] = channel.split(':');
+    if (namespace !== 'contest' || !contestKey || rest.length || !Object.values(ContestChannelRole).includes(role)) {
+        return null;
+    }
+    return { contestKey: decodeURIComponent(contestKey), role: role };
+};
+/**
+ * Returns the problem and role of a `CHANNEL_PROBLEM` channel name, or null if it is not one.
+ */
+export const getProblemChannelParams = (channel) => {
+    const [namespace, problemKey, role, ...rest] = channel.split(':');
+    if (namespace !== 'problem' || !problemKey || rest.length || !Object.values(ProblemChannelRole).includes(role)) {
+        return null;
+    }
+    return { problemKey: decodeURIComponent(problemKey), role: role };
+};

package/dist/{types/constants → constants}/worksheet.d.ts

@@ -1,4 +1,4 @@
-import { AspectRatio, NewPageSheet } from '../types';
+import { AspectRatio, NewPageSheet } from '../types/index.js';
 export declare const NEW_PAGE_SHEET: () => NewPageSheet;
 export declare const ASPECT_RATIO: {
     [key in AspectRatio]: {

package/dist/constants/worksheet.js

@@ -0,0 +1,66 @@
+import { v4 } from 'uuid';
+import { AspectRatio, WorksheetType } from '../types/index.js';
+export const NEW_PAGE_SHEET = () => ({
+    id: v4(),
+    type: WorksheetType.NEW_PAGE,
+    title: '',
+    points: 0,
+});
+export const ASPECT_RATIO = {
+    [AspectRatio.RATIO_21_9]: {
+        aspectRatio: AspectRatio.RATIO_21_9,
+        width: 2520,
+        height: 1080,
+        decimal: 21 / 9,
+        label: 'ultrawide',
+    },
+    [AspectRatio.RATIO_20_9]: {
+        aspectRatio: AspectRatio.RATIO_20_9,
+        width: 2400,
+        height: 1080,
+        decimal: 20 / 9,
+        label: 'mobile wide',
+    },
+    [AspectRatio.RATIO_16_9]: {
+        aspectRatio: AspectRatio.RATIO_16_9,
+        width: 1920,
+        height: 1080,
+        decimal: 16 / 9,
+        label: 'widescreen',
+    },
+    [AspectRatio.RATIO_16_10]: {
+        aspectRatio: AspectRatio.RATIO_16_10,
+        width: 1920,
+        height: 1200,
+        decimal: 16 / 10,
+        label: 'widescreen tall',
+    },
+    [AspectRatio.RATIO_3_2]: {
+        aspectRatio: AspectRatio.RATIO_3_2,
+        width: 1440,
+        height: 960,
+        decimal: 3 / 2,
+        label: 'balanced',
+    },
+    [AspectRatio.RATIO_4_3]: {
+        aspectRatio: AspectRatio.RATIO_4_3,
+        width: 1024,
+        height: 768,
+        decimal: 4 / 3,
+        label: 'standard',
+    },
+    [AspectRatio.RATIO_5_4]: {
+        aspectRatio: AspectRatio.RATIO_5_4,
+        width: 1280,
+        height: 1024,
+        decimal: 5 / 4,
+        label: 'square old',
+    },
+    [AspectRatio.RATIO_1_1]: {
+        aspectRatio: AspectRatio.RATIO_1_1,
+        width: 1000,
+        height: 1000,
+        decimal: 1,
+        label: 'square',
+    },
+};

package/dist/{types/dto → dto}/class.d.ts

@@ -1,6 +1,6 @@
-import { AssignmentBasicInfo, AssignmentClass, ClassBaseDocument, ClassCycleTag, EntityState } from '../types';
-import { EntityMembersDto, EntityMembersResponseDto } from './entity';
-import { UserOrganizationBasicInfoResponseDto, UserSummaryListResponseDto } from './user';
+import { AssignmentBasicInfo, AssignmentClass, ClassBaseDocument, ClassCycleTag, EntityState } from '../types/index.js';
+import { EntityMembersDto, EntityMembersResponseDto } from './entity.js';
+import { UserOrganizationBasicInfoResponseDto, UserSummaryListResponseDto } from './user.js';
 interface ClassUserResponseDto {
     isOwner: boolean;
     isManager: boolean;

package/dist/dto/class.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/code.d.ts

@@ -1,4 +1,4 @@
-import { JudgingFile } from '../types';
+import { JudgingFile } from '../types/index.js';
 export interface CodeRunDto {
     runId: string;
     timeLimit: number;

package/dist/dto/code.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/comments.d.ts

@@ -1,4 +1,4 @@
-import { UserOrganizationBasicInfoResponseDto } from './user';
+import { UserOrganizationBasicInfoResponseDto } from './user.js';
 export type ReactionUserResponseData = {
     key: string;
     user: UserOrganizationBasicInfoResponseDto;

package/dist/dto/comments.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/contest.d.ts

@@ -1,7 +1,7 @@
-import { ContestBaseDocument, ContestEventAction, ContestProblemPrerequisite, ContestProblem, ContestSettings, ContestTimeFlags, ContestUser, EntityState, ProblemSettings, ProblemStatement, TextLanguage } from '../types';
-import { EntityMembersDto, EntityMembersWithTimestampsResponseDto } from './entity';
-import { EntityOrganizationSummaryListResponseDto, EntityOrganizationSystemSummaryListResponseDto, ProblemJudgeSummaryListResponseDto, ProblemSummaryListResponseDto } from './problem';
-import { EntityOwnerSystemSummaryListResponseDto, UserOrganizationBasicInfoResponseDto } from './user';
+import { ContestBaseDocument, ContestEventAction, ContestProblemPrerequisite, ContestProblem, ContestSettings, ContestTimeFlags, ContestUser, EntityState, ProblemSettings, ProblemStatement, TextLanguage } from '../types/index.js';
+import { EntityMembersDto, EntityMembersWithTimestampsResponseDto } from './entity.js';
+import { EntityOrganizationSummaryListResponseDto, EntityOrganizationSystemSummaryListResponseDto, ProblemJudgeSummaryListResponseDto, ProblemSummaryListResponseDto } from './problem.js';
+import { EntityOwnerSystemSummaryListResponseDto, UserOrganizationBasicInfoResponseDto } from './user.js';
 export type UpsertContestProblemPrerequisiteDto = (Omit<ContestProblemPrerequisite, 'problemId'> & {
     problemIndex: string;
 })[];

package/dist/dto/contest.js

@@ -0,0 +1,7 @@
+export var ContestProblemBlockedByType;
+(function (ContestProblemBlockedByType) {
+    ContestProblemBlockedByType["UNMET_PREREQUISITES"] = "UNMET_PREREQUISITES";
+    ContestProblemBlockedByType["MAX_ACCEPTED_SUBMISSIONS_ACHIEVED"] = "MAX_ACCEPTED_SUBMISSIONS_ACHIEVED";
+    ContestProblemBlockedByType["START_TIME_IN_THE_FUTURE"] = "START_TIME_IN_THE_FUTURE";
+    ContestProblemBlockedByType["END_TIME_IN_THE_PAST"] = "END_TIME_IN_THE_PAST";
+})(ContestProblemBlockedByType || (ContestProblemBlockedByType = {}));

package/dist/{types/dto → dto}/course.d.ts

@@ -1,7 +1,7 @@
-import { CourseBaseDocument } from '../types';
-import { EntityMembersDto, EntityMembersResponseDto } from './entity';
-import { UserOrganizationBasicInfoResponseDto } from './user';
-import { WorksheetSummaryListResponseDto } from './worksheet';
+import { CourseBaseDocument } from '../types/index.js';
+import { EntityMembersDto, EntityMembersResponseDto } from './entity.js';
+import { UserOrganizationBasicInfoResponseDto } from './user.js';
+import { WorksheetSummaryListResponseDto } from './worksheet.js';
 export type CourseUserResponseDto = {
     isOwner: boolean;
     isManager: boolean;

package/dist/dto/course.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/entity.d.ts

@@ -1,5 +1,5 @@
-import { EntityAccess, EntityLogChanges, EntityMembersRank } from '../types';
-import { UserOrganizationBasicInfoResponseDto } from './user';
+import { EntityAccess, EntityLogChanges, EntityMembersRank } from '../types/index.js';
+import { UserOrganizationBasicInfoResponseDto } from './user.js';
 export interface EntityMembersDto {
     rankAdministrators: EntityMembersRank;
     administrators: string[];

package/dist/dto/entity.js

@@ -0,0 +1,5 @@
+export var MemberType;
+(function (MemberType) {
+    MemberType["USER"] = "USER";
+    MemberType["TEAM"] = "TEAM";
+})(MemberType || (MemberType = {}));

package/dist/{types/dto → dto}/excalidraw.d.ts

@@ -1,6 +1,6 @@
-import { ExcalidrawBaseDocument } from '../types';
-import { EntityMembersDto, EntityMembersResponseDto } from './entity';
-import { UserOrganizationBasicInfoResponseDto } from './user';
+import { ExcalidrawBaseDocument } from '../types/index.js';
+import { EntityMembersDto, EntityMembersResponseDto } from './entity.js';
+import { UserOrganizationBasicInfoResponseDto } from './user.js';
 export interface ExcalidrawResponseDto extends Omit<ExcalidrawBaseDocument, 'members'> {
     owner: UserOrganizationBasicInfoResponseDto;
     members: EntityMembersResponseDto;

package/dist/dto/excalidraw.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/file.d.ts

@@ -1,5 +1,5 @@
-import { FileBasic, FileContent, FileMemberRole, SummaryFileContent, UserBasic } from '../types';
-import { DocumentMembersResponseDto, DocumentUserResponseDto } from './entity';
+import { FileBasic, FileContent, FileMemberRole, SummaryFileContent, UserBasic } from '../types/index.js';
+import { DocumentMembersResponseDto, DocumentUserResponseDto } from './entity.js';
 export interface CreateFileDto extends FileBasic {
     folderId: string;
     content: FileContent;

package/dist/dto/file.js

@@ -0,0 +1 @@
+export {};

package/dist/dto/image.js

@@ -0,0 +1 @@
+export {};

package/dist/dto/index.d.ts

@@ -0,0 +1,25 @@
+export * from './class.js';
+export * from './code.js';
+export * from './comments.js';
+export * from './organization.js';
+export * from './contest.js';
+export * from './course.js';
+export * from './entity.js';
+export * from './excalidraw.js';
+export * from './file.js';
+export * from './image.js';
+export * from './judge.js';
+export * from './problem.js';
+export * from './markdown.js';
+export * from './mermaid.js';
+export * from './scoreboard.js';
+export * from './session.js';
+export * from './socket.js';
+export * from './statistics.js';
+export * from './submission.js';
+export * from './system.js';
+export * from './url.js';
+export * from './user.js';
+export * from './virtual-user.js';
+export * from './worksheet.js';
+export * from './worksheet-submissions.js';

package/dist/dto/index.js

@@ -0,0 +1,25 @@
+export * from './class.js';
+export * from './code.js';
+export * from './comments.js';
+export * from './organization.js';
+export * from './contest.js';
+export * from './course.js';
+export * from './entity.js';
+export * from './excalidraw.js';
+export * from './file.js';
+export * from './image.js';
+export * from './judge.js';
+export * from './problem.js';
+export * from './markdown.js';
+export * from './mermaid.js';
+export * from './scoreboard.js';
+export * from './session.js';
+export * from './socket.js';
+export * from './statistics.js';
+export * from './submission.js';
+export * from './system.js';
+export * from './url.js';
+export * from './user.js';
+export * from './virtual-user.js';
+export * from './worksheet.js';
+export * from './worksheet-submissions.js';

package/dist/{types/dto → dto}/judge.d.ts

@@ -1,4 +1,4 @@
-import { JudgeBaseDocument } from '../types';
+import { JudgeBaseDocument } from '../types/index.js';
 export interface JudgeDataResponseDto extends Omit<JudgeBaseDocument, 'getProblemUrl' | 'getUserSubmissionsUrl' | 'getLoginUrl' | 'getSubmitUrl'> {
 }
 export interface JudgeSummaryListResponseDto extends Omit<JudgeBaseDocument, 'getProblemUrl' | 'getUserSubmissionsUrl' | 'getSubmissionUrl' | 'getLoginUrl' | 'getProfileUrl' | 'getSubmitUrl'> {

package/dist/dto/judge.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/markdown.d.ts

@@ -1,6 +1,6 @@
-import { MarkdownBaseDocument } from '../types';
-import { EntityMembersDto, EntityMembersResponseDto } from './entity';
-import { UserOrganizationBasicInfoResponseDto } from './user';
+import { MarkdownBaseDocument } from '../types/index.js';
+import { EntityMembersDto, EntityMembersResponseDto } from './entity.js';
+import { UserOrganizationBasicInfoResponseDto } from './user.js';
 export interface MarkdownResponseDto extends Omit<MarkdownBaseDocument, 'members'> {
     owner: UserOrganizationBasicInfoResponseDto;
     members: EntityMembersResponseDto;

package/dist/dto/markdown.js

@@ -0,0 +1 @@
+export {};

package/dist/{types/dto → dto}/mermaid.d.ts

@@ -1,6 +1,6 @@
-import { MermaidBaseDocument } from '../types';
-import { EntityMembersDto, EntityMembersResponseDto } from './entity';
-import { UserOrganizationBasicInfoResponseDto } from './user';
+import { MermaidBaseDocument } from '../types/index.js';
+import { EntityMembersDto, EntityMembersResponseDto } from './entity.js';
+import { UserOrganizationBasicInfoResponseDto } from './user.js';
 export interface MermaidResponseDto extends Omit<MermaidBaseDocument, 'members'> {
     owner: UserOrganizationBasicInfoResponseDto;
     members: EntityMembersResponseDto;