@juki-team/commons 0.1.11

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

@@ -0,0 +1,10 @@
+import { BasicWorksheet, BodyWorksheet, CodeEditorSheet, JkmdSheet, QuizOptionsSheet, QuizProblemSheet, QuizTextSheet, SummaryWorksheetsInPages, WorksheetsInPages } from '../types';
+export declare const getWorksheetsInPages: (initialSheets: BodyWorksheet[]) => WorksheetsInPages;
+export declare const getSummaryWorksheetsInPages: (initialSheets: BodyWorksheet[]) => SummaryWorksheetsInPages;
+export declare const getTotalExercisesOfSummaryWorksheetsInPages: (content: SummaryWorksheetsInPages) => number;
+export declare const isBasicWorksheet: (value: any) => value is BasicWorksheet & any;
+export declare const isJkmdSheet: (value: any) => value is JkmdSheet;
+export declare const isCodeEditorSheet: (value: any) => value is CodeEditorSheet;
+export declare const isQuizProblemSheet: (value: any) => value is QuizProblemSheet;
+export declare const isQuizOptionsSheet: (value: any) => value is QuizOptionsSheet;
+export declare const isQuizTextSheet: (value: any) => value is QuizTextSheet;

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './constants';
+export * from './dto';
+export * from './helpers';
+export * from './prototypes';
+export * from './types';

package/dist/types/prototypes/Date.d.ts

@@ -0,0 +1,62 @@
+declare global {
+    interface Date {
+        changeYear(year: number): Date;
+        changeMonth(monthIndex: number): Date;
+        changeDay(date: number): Date;
+        changeHours(hours: number): Date;
+        changeMinutes(minutes: number): Date;
+        changeSeconds(seconds: number): Date;
+        changeMilliseconds(milliseconds: number): Date;
+        decreaseYear(count?: number): Date;
+        increaseYear(count?: number): Date;
+        decreaseMonth(): Date;
+        increaseMonth(): Date;
+        decreaseDay(): Date;
+        increaseDay(): Date;
+        startOfYear(): Date;
+        endOfYear(): Date;
+        startOfMonth(): Date;
+        endOfMonth(): Date;
+        startOfWeek(): Date;
+        endOfWeek(): Date;
+        startOfDay(): Date;
+        endOfDay(): Date;
+        startOfHour(): Date;
+        endOfHour(): Date;
+        startOfMinute(): Date;
+        endOfMinute(): Date;
+        startOfSecond(): Date;
+        endOfSecond(): Date;
+        isSameYear(date: Date): boolean;
+        isSameMonth(date: Date): boolean;
+        isSameDay(date: Date): boolean;
+        isSameHour(date: Date): boolean;
+        isSameMinute(date: Date): boolean;
+        isSameSecond(date: Date): boolean;
+        isSameMillisecond(date: Date): boolean;
+        isToday(): boolean;
+        isEqual(date: Date): boolean;
+        isValidDate(): boolean;
+        isYearAfter(date: Date): boolean;
+        isMonthAfter(date: Date): boolean;
+        isDayAfter(date: Date): boolean;
+        isHoursAfter(date: Date): boolean;
+        isMinutesAfter(date: Date): boolean;
+        isSecondsAfter(date: Date): boolean;
+        isMillisecondsAfter(date: Date): boolean;
+        isAfter(date: Date): boolean;
+        isYearBefore(date: Date): boolean;
+        isMonthBefore(date: Date): boolean;
+        isDayBefore(date: Date): boolean;
+        isHoursBefore(date: Date): boolean;
+        isMinutesBefore(date: Date): boolean;
+        isSecondsBefore(date: Date): boolean;
+        isMillisecondsBefore(date: Date): boolean;
+        isBefore(date: Date): boolean;
+        isWithinInterval(props: {
+            start: Date;
+            end: Date;
+        }, cmp?: '[]' | '()' | '[)' | '(]'): boolean;
+    }
+}
+export {};

package/dist/types/prototypes/Error.d.ts

@@ -0,0 +1,10 @@
+import { ErrorCode } from '../types';
+export declare class JkError extends Error {
+    code: ErrorCode;
+    data: any;
+    constructor(code: ErrorCode, custom?: {
+        message?: string;
+        stack?: string;
+        data?: any;
+    });
+}

package/dist/types/prototypes/Number.d.ts

@@ -0,0 +1,7 @@
+declare global {
+    interface Number {
+        padStart(maxLength: number, fillString?: string): String;
+        padEnd(maxLength: number, fillString?: string): String;
+    }
+}
+export {};

package/dist/types/prototypes/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Date';
+export * from './Error';
+export * from './Number';

package/dist/types/types/account.d.ts

@@ -0,0 +1,9 @@
+export declare enum ProfileSetting {
+    NEWSLETTER_SUBSCRIPTION = "newsletterSubscription",
+    LANGUAGE = "preferredLanguage",
+    THEME = "preferredTheme",
+    DATA_VIEW_MODE = "preferredDataViewMode",
+    MENU_VIEW_MODE = "preferredMenuViewMode",
+    TIME_ZONE = "preferredTimeZone",
+    FONT_SIZE = "preferredFontSize"
+}

package/dist/types/types/class.d.ts

@@ -0,0 +1,67 @@
+import { BodyWorksheet } from '../types/sheet';
+import { EntityMembers, EntityState } from './entity';
+export declare enum AssignmentClass {
+    NONE = "NONE",
+    COURSE = "COURSE",
+    WORKSHEET = "WORKSHEET",
+    CONTEST = "CONTEST"
+}
+export interface AssignmentBasicInfo {
+    id: string;
+    index: number;
+    type: AssignmentClass;
+    points: number;
+    startTimestamp: number;
+    endTimestamp: number;
+    title: string;
+    content: BodyWorksheet[];
+    tags: string[];
+    graded: boolean;
+    visible: boolean;
+}
+export interface ClassCycleSessionAssignment extends AssignmentBasicInfo {
+    entityId: string;
+    state: EntityState;
+}
+export interface ClassCycleSessionAssignments {
+    [key: string]: ClassCycleSessionAssignment;
+}
+interface ClassCycleSession {
+    id: string;
+    index: number;
+    name: string;
+    assignments: ClassCycleSessionAssignments;
+    startTimestamp: number;
+    endTimestamp: number;
+    state: EntityState;
+}
+export interface ClassCycleSessions {
+    [key: string]: ClassCycleSession;
+}
+export type ClassCycleTag = {
+    key: string;
+    name: string;
+    color: string;
+    points: number;
+};
+export type ClassCycle = {
+    id: string;
+    index: number;
+    name: string;
+    sessions: ClassCycleSessions;
+    tags: ClassCycleTag[];
+    startTimestamp: number;
+    endTimestamp: number;
+    state: EntityState;
+};
+export interface ClassCycles {
+    [key: string]: ClassCycle;
+}
+export interface ClassBaseDocument {
+    key: string;
+    name: string;
+    description: string;
+    members: EntityMembers;
+    cycles: ClassCycles;
+}
+export {};

package/dist/types/types/comments.d.ts

@@ -0,0 +1,17 @@
+export type ReactionUser = {
+    key: string;
+    userId: string;
+    createdTimestamp: number;
+    updatedTimestamp: number;
+};
+export interface CommentBaseDocument {
+    key: string;
+    parentId: string | null;
+    content: string;
+    hidden: boolean;
+    reactions: {
+        [key: string]: {
+            [key: string]: ReactionUser;
+        };
+    };
+}

package/dist/types/types/commons.d.ts

@@ -0,0 +1,84 @@
+import { Language } from './prisma';
+export declare enum CodeLanguage {
+    C_11 = "c11",
+    CPP_11 = "cpp11",
+    CPP_20 = "cpp20",
+    JAVA_21 = "java21",
+    PYTHON_3 = "python3",
+    PYTHON_PYPY_3 = "pypy3",
+    JAVASCRIPT_NODE_JS_22 = "nodejs22",
+    PYTHON_2 = "python2",
+    PYTHON_PYPY_2 = "pypy2",
+    ICPC_C = "ICPC_C",
+    C = "C",
+    CPP = "CPP",
+    ICPC_CPP = "ICPC_CPP",
+    CPP11 = "CPP11",
+    CPP14 = "CPP14",
+    CPP17 = "CPP17",
+    JAVA = "JAVA",
+    ICPC_PYTHON = "ICPC_PYTHON",
+    PYTHON = "PYTHON",
+    PYTHON2 = "PYTHON2",
+    PYTHON3 = "PYTHON3",
+    JAVASCRIPT = "JAVASCRIPT",
+    TYPESCRIPT = "TYPESCRIPT",
+    JSX = "JSX",
+    TSX = "TSX",
+    MDX = "MDX",
+    PSEUDOCODE_PSEINT = "PSEUDOCODE_PSEINT",
+    LATEX = "LATEX",
+    JSON = "JSON",
+    HTML = "HTML",
+    TEXT = "TEXT",
+    DIFF = "DIFF",
+    MARKDOWN = "MARKDOWN",
+    ARDUINO = "ARDUINO",
+    DOT = "DOT",
+    MERMAID = "MERMAID",
+    BASH = "BASH"
+}
+export declare enum ScopeData {
+    USER = "USER",
+    PROBLEM = "PROBLEM",
+    CONTEST = "CONTEST",
+    ATTEMPT = "ATTEMPT"
+}
+export declare enum Status {
+    SUCCESS = "SUCCESS",
+    ERROR = "ERROR",
+    LOADING = "LOADING",
+    NONE = "NONE"
+}
+export declare enum EntityStatus {
+    PUBLIC = "PUBLIC",// Active for the users
+    RESERVED = "RESERVED",// On preparation
+    PRIVATE = "PRIVATE",
+    ARCHIVED = "ARCHIVED"
+}
+export declare enum EntityAccess {
+    PRIVATE = "PRIVATE",
+    RESTRICTED = "RESTRICTED",
+    PUBLIC = "PUBLIC",
+    EXPOSED = "EXPOSED"
+}
+export type TextLanguage = {
+    [key in Language]: string;
+};
+export type SplitTime = {
+    remaining: number;
+    label: string;
+    milliseconds: number;
+    abbreviatedLabel: string;
+    digits: number;
+};
+export type RecordId = `${string & {
+    length: 24;
+}}`;
+export type Device = {
+    label: string;
+    isMobile: boolean;
+    isBrowser: boolean;
+    type: string;
+    osLabel: string;
+};

package/dist/types/types/company.d.ts

@@ -0,0 +1,29 @@
+export declare enum CompanyPlan {
+    FREE = "FREE",// shared runner and shared compiles
+    STANDARD = "STANDARD",// 1 dedicated runner, 1 dedicated compiler
+    PREMIUM = "PREMIUM",// 1 dedicated runner, 1 dedicated compiler + extra hours billed
+    CUSTOM = "CUSTOM"
+}
+export declare enum CompanyLogoType {
+    HORIZONTAL_WHITE = "horizontal-white",
+    HORIZONTAL_COLOR = "horizontal-color",
+    VERTICAL_WHITE = "vertical-white",
+    VERTICAL_COLOR = "vertical-color"
+}
+export type ResourceInstance = {
+    imageId: string;
+    instanceType: string;
+    userDataScript: string;
+    minimum: number;
+    maximum: number;
+};
+export type ResourceLogger = {
+    info: {
+        chatId: string;
+        messageThreadId: string;
+    };
+    error: {
+        chatId: string;
+        messageThreadId: string;
+    };
+};

package/dist/types/types/contest.d.ts

@@ -0,0 +1,161 @@
+import { ContestDataResponseDTO, UpsertContestDTO, UserCompanyBasicInfoResponseDTO } from '../dto';
+import { CodeLanguage } from './commons';
+import { EntityMembers } from './entity';
+import { Judge } from './judge';
+import { UserBasicInfo } from './users';
+export declare enum ContestStatus {
+    PUBLIC = "PUBLIC",
+    RESERVED = "RESERVED",
+    ARCHIVED = "ARCHIVED"
+}
+export declare enum ContestTimeStatus {
+    UPCOMING = "upcoming",
+    LIVE = "live",
+    PAST = "past"
+}
+export type MetaProblemSearcher = {
+    name: string;
+    url: string;
+    id: string;
+    rating: number;
+    tag: string;
+    judge: Judge;
+};
+export type BaseClarification = {
+    answer: string;
+    publicVisible: boolean;
+};
+export interface NewClarification extends BaseClarification {
+    problem: string;
+    question: string;
+}
+export interface AnswerClarification extends NewClarification {
+    answered: boolean;
+    answeredTime: number;
+    judgeType: false;
+    user: string;
+    userAnswer: string;
+    id: string;
+}
+export type ContestUser = {
+    isOwner: boolean;
+    isAdministrator: boolean;
+    isManager: boolean;
+    isParticipant: boolean;
+    isGuest: boolean;
+    isSpectator: boolean;
+};
+export type ContestClarification = {
+    key: string;
+    problemJudgeKey: string;
+    question: string;
+    questionUser: UserCompanyBasicInfoResponseDTO;
+    questionTimestamp: number;
+    answer: string;
+    answerTimestamp: number;
+    answerUser: UserCompanyBasicInfoResponseDTO;
+    public: boolean;
+};
+export declare enum ContestProblemPrerequisiteType {
+    INDIVIDUALLY = "INDIVIDUALLY",
+    CONTEST = "CONTEST"
+}
+export type ContestProblemPrerequisite = {
+    problemId: string;
+    type: ContestProblemPrerequisiteType;
+    delay: number;
+};
+export type ContestProblem = {
+    id: string;
+    index: string;
+    points: number;
+    color: string;
+    startTimestamp: number;
+    endTimestamp: number;
+    prerequisites: ContestProblemPrerequisite[];
+    maxAcceptedUsers: number;
+    group: string;
+};
+export type ContestSettings = {
+    clarifications: boolean;
+    numberJudgeValidations: number;
+    languages: CodeLanguage[];
+    penalty: number;
+    timeToSolve: number;
+    startTimestamp: number;
+    frozenTimestamp: number;
+    quietTimestamp: number;
+    endTimestamp: number;
+    scoreboardLocked: boolean;
+    upsolvingEnabled: boolean;
+};
+export type MemberUserData = {
+    userId: string;
+    lastVisitTimestamp: number | null;
+    joinedAtTimestamp: number;
+};
+export type ContestMembersBasic = {
+    administrators: {
+        [key: string]: MemberUserData;
+    };
+    judges: {
+        [key: string]: MemberUserData;
+    };
+    guests: {
+        [key: string]: MemberUserData;
+    };
+    spectators: {
+        [key: string]: MemberUserData;
+    };
+};
+export declare enum ContestEventAction {
+    DATA_UPDATE = "DATA_UPDATE",
+    SCOREBOARD_RECALCULATE = "SCOREBOARD_RECALCULATE",
+    SCOREBOARD_UNLOCK = "SCOREBOARD_UNLOCK",
+    SCOREBOARD_LOCK = "SCOREBOARD_LOCK",
+    ENABLE_UPSOLVING = "ENABLE_UPSOLVING",
+    DISABLE_UPSOLVING = "DISABLE_UPSOLVING",
+    PARTICIPANT_JOIN = "PARTICIPANT_JOIN"
+}
+export interface ContestEvent {
+    action: ContestEventAction;
+    userId: string;
+    timestamp: number;
+    details: Record<string, any>;
+}
+export interface ContestGroup {
+    label: string;
+    value: string;
+    color: string;
+}
+export interface ContestBaseDocument {
+    key: string;
+    name: string;
+    description: string;
+    settings: ContestSettings;
+    problems: Record<string, ContestProblem>;
+    members: EntityMembers;
+    tags: string[];
+    groups: Record<string, ContestGroup>;
+    events: ContestEvent[];
+}
+export type ContestMembersResponse = {
+    administrators: {
+        [key: string]: UserBasicInfo;
+    };
+    judges: {
+        [key: string]: UserBasicInfo;
+    };
+    guests: {
+        [key: string]: UserBasicInfo;
+    };
+    spectators: {
+        [key: string]: UserBasicInfo;
+    };
+    contestants: {
+        [key: string]: UserBasicInfo;
+    };
+};
+export type ContestTimeData = Pick<ContestDataResponseDTO, 'isLive' | 'isFrozenTime' | 'isQuietTime' | 'isEndless' | 'isPast' | 'isFuture' | 'isGlobal'> & {
+    settings: Pick<UpsertContestDTO['settings'], 'penalty' | 'startTimestamp' | 'frozenTimestamp' | 'quietTimestamp' | 'endTimestamp' | 'upsolvingEnabled'>;
+};

package/dist/types/types/course.d.ts

@@ -0,0 +1,13 @@
+import { EntityMembers, EntityState } from './entity';
+export interface CourseBaseDocument {
+    key: string;
+    title: string;
+    abstract: string;
+    description: string;
+    coverImageUrl: string;
+    state: EntityState;
+    lessons: {
+        worksheetId: string;
+    }[];
+    members: EntityMembers;
+}

package/dist/types/types/entity.d.ts

@@ -0,0 +1,116 @@
+import { UserCompanyBasicInfoResponseDTO } from '../dto';
+export declare enum EntityMembersRank {
+    NONE = "NONE",
+    CLOSE = "CLOSE",
+    OPEN = "OPEN"
+}
+export declare enum EntityState {
+    RELEASED = "RELEASED",
+    ARCHIVED = "ARCHIVED"
+}
+export type EntityUsersMemberUserData = {
+    userId: string;
+    lastVisitTimestamp: number | null;
+    joinedAtTimestamp: number;
+};
+export type EntityTeamsMemberUserData = {
+    teamId: string;
+    lastVisitTimestamp: number | null;
+    joinedAtTimestamp: number;
+};
+export type EntityMembersUserData = EntityUsersMemberUserData | EntityTeamsMemberUserData;
+export interface EntityMembers {
+    rankAdministrators: EntityMembersRank;
+    administrators: {
+        [key: string]: EntityMembersUserData;
+    };
+    rankManagers: EntityMembersRank;
+    managers: {
+        [key: string]: EntityMembersUserData;
+    };
+    rankGuests: EntityMembersRank;
+    guests: {
+        [key: string]: EntityMembersUserData;
+    };
+    rankSpectators: EntityMembersRank;
+    spectators: {
+        [key: string]: EntityMembersUserData;
+    };
+    rankParticipants: EntityMembersRank;
+    participants: {
+        [key: string]: EntityMembersUserData;
+    };
+}
+export interface EntityOwnerDocument {
+    ownerUserId: string;
+}
+export interface EntityCompanyDocument {
+    companyId: string;
+}
+export interface EntityTimestampsDocument {
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface EntityStateDocument {
+    state: EntityState;
+}
+export interface EntityLogChanges {
+    key: string;
+    path: string;
+    valueType: string | null;
+    value?: any;
+    oldValue?: any;
+    type: LogOperation;
+}
+export interface EntityLog {
+    changes: EntityLogChanges[];
+    timestamp: number;
+    customerUserId: string;
+}
+export interface EntityLogsDocument {
+    logs: EntityLog[];
+}
+export type NewEntityDocument<T> = T & EntityCompanyDocument & EntityOwnerDocument & EntityTimestampsDocument & EntityStateDocument & EntityLogsDocument;
+export type CreateEntityDocument<T> = Omit<T, '_id' | 'createdAt' | 'updatedAt' | 'companyId' | 'ownerUserId' | 'state' | 'logs'>;
+export type UpdateEntityDocument<T> = Partial<Omit<T, '_id' | 'createdAt' | 'updatedAt' | 'companyId' | 'ownerUserId' | 'state' | 'logs' | 'key'>>;
+export declare enum EntityCollection {
+    COMPANY = "COMPANY",
+    PROBLEM = "PROBLEM",
+    CONTEST = "CONTEST",
+    JUDGE = "JUDGE",
+    USER = "USER",
+    SUBMISSION = "SUBMISSION"
+}
+export declare enum CollectionKey {
+    COMPANY = "C",
+    USER = "U",
+    PROBLEM = "P",
+    CLASS = "K",
+    CLASS_ASSIGNMENT = "KA",
+    CONTEST = "T",
+    SCOREBOARD = "B",
+    SCOREBOARD_EVENTS = "BE",
+    COURSE = "R",
+    FILE = "F",
+    GROUP = "G",
+    JUDGE = "J",
+    WORKSHEET = "W",
+    WORKSHEET_SUBMISSIONS = "WS",
+    SUBMIT = "S",
+    LOCALE = "L",
+    COMMENT = "M",
+    EXCALIDRAW = "E",
+    MARKDOWN = "MD",
+    DOCUMENT_TEMPLATE = "DT",
+    MERMAID = "MM"
+}
+export declare enum LogOperation {
+    REMOVE = "REMOVE",
+    ADD = "ADD",
+    UPDATE = "UPDATE"
+}
+export interface LogDataResponseDTO {
+    changes: EntityLogChanges[];
+    timestamp: number;
+    customerUser: UserCompanyBasicInfoResponseDTO;
+}

package/dist/types/types/excalidraw.d.ts

@@ -0,0 +1,9 @@
+import { EntityMembers } from './entity';
+export interface ExcalidrawBaseDocument {
+    key: string;
+    name: string;
+    elements: any;
+    appState: any;
+    members: EntityMembers;
+    tags: string[];
+}

package/dist/types/types/file.d.ts

@@ -0,0 +1,27 @@
+import { Role } from './users';
+export type FileRole = Role.RESTRICTED | Role.GUEST | Role.REGULAR | Role.MASTER | Role.ADMIN | Role.SUPER_ADMIN;
+export declare enum FileMemberRole {
+    VIEWER = "VIEWER",
+    EDITOR = "EDITOR"
+}
+export declare enum FileType {
+    FOLDER = "FOLDER",
+    FILE = "FILE"
+}
+export type FolderFileContent = {
+    type: FileType.FOLDER;
+};
+export type FileFileContent = {
+    type: FileType.FILE;
+    mime: string;
+    key: string;
+};
+export type FileContent = FolderFileContent | FileFileContent;
+export type SummaryFileContent = FolderFileContent | Omit<FileFileContent, 'key'>;
+export declare enum FilesJukiPub {
+    SHARED = "shared",// files to share
+    SHARED_EXCALIDRAW = "shared/E",
+    TEMP = "temp",// temporal files
+    PROBLEMS = "problems",
+    CONTESTS = "contests"
+}

package/dist/types/types/group.d.ts

@@ -0,0 +1,12 @@
+import { EntityMembers, EntityState } from './entity';
+export declare enum GroupType {
+    CLASS = "CLASS",
+    TEAM = "TEAM"
+}
+export interface GroupBaseDocument {
+    name: string;
+    description: string;
+    state: EntityState;
+    types: GroupType;
+    members: EntityMembers;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,25 @@
+export * from './account';
+export * from './class';
+export * from './comments';
+export * from './commons';
+export * from './company';
+export * from './contest';
+export * from './course';
+export * from './entity';
+export * from './excalidraw';
+export * from './file';
+export * from './group';
+export * from './judge';
+export * from './markdown';
+export * from './mermaid';
+export * from './notification';
+export * from './prisma';
+export * from './problems';
+export * from './services';
+export * from './sheet';
+export * from './socket';
+export * from './submission';
+export * from './teams';
+export * from './users';
+export * from './virtual-user';
+export * from './worksheet';