@juki-team/commons 0.1.11

package/dist/types/types/sheet.d.ts

@@ -0,0 +1,103 @@
+import { CodeLanguage } from './commons';
+import { SubmissionRunStatus } from './judge';
+export declare enum WorksheetType {
+    JK_MD = "JK_MD",
+    CODE_EDITOR = "CODE_EDITOR",
+    LIST = "LIST",
+    GRAPH = "GRAPH",
+    QUIZ_PROBLEM = "QUIZ_PROBLEM",
+    QUIZ_TEXT = "QUIZ_TEXT",
+    QUIZ_OPTIONS = "QUIZ_OPTIONS",
+    NEW_PAGE = "NEW_PAGE"
+}
+export type BasicWorksheet = {
+    id: string;
+    type: WorksheetType;
+    title: string;
+    points: number;
+};
+export type JkmdSheet = BasicWorksheet & {
+    type: WorksheetType.JK_MD;
+    content: string;
+};
+export type SubmissionTestCase = {
+    out: string;
+    err: string;
+    log: string;
+    status: SubmissionRunStatus;
+};
+export interface CodeEditorTestCase extends SubmissionTestCase {
+    key: string;
+    in: string;
+    testOut: string;
+    withPE: boolean;
+    sample: boolean;
+    hidden: boolean;
+    index: number;
+    messageTimestamp: number;
+}
+export type CodeEditorFile<T> = {
+    description: string;
+    folderPath: string;
+    source: string;
+    language: T;
+    index: number;
+    name: string;
+    hidden: boolean;
+    readonly: boolean;
+    protected: boolean;
+};
+export type CodeEditorFiles<T> = {
+    [key: string]: CodeEditorFile<T>;
+};
+export type CodeEditorTestCases = {
+    [key: string]: CodeEditorTestCase;
+};
+export type CodeEditorSheet = BasicWorksheet & {
+    type: WorksheetType.CODE_EDITOR;
+    files: CodeEditorFiles<CodeLanguage>;
+    testCases: CodeEditorTestCases;
+    languages: CodeLanguage[];
+    height: number;
+};
+export type GraphSheet = BasicWorksheet & {
+    type: WorksheetType.GRAPH;
+    dots: string[];
+};
+export type QuizProblemSheet = BasicWorksheet & {
+    type: WorksheetType.QUIZ_PROBLEM;
+    problemKey: string;
+    languages: CodeLanguage[];
+    height: number;
+};
+export type QuizTextSheet = BasicWorksheet & {
+    type: WorksheetType.QUIZ_TEXT;
+    description: string;
+    answer: string;
+    inputType: 'text' | 'number' | 'textarea';
+};
+export declare enum QuizScoringMode {
+    TOTAL = "TOTAL",
+    PARTIAL = "PARTIAL"
+}
+export type QuizOptionsSheet = BasicWorksheet & {
+    type: WorksheetType.QUIZ_OPTIONS;
+    description: string;
+    options: {
+        label: string;
+        correct: boolean;
+        id: string;
+    }[];
+    multiple: boolean;
+    scoringMode: QuizScoringMode;
+};
+export type ListSheet = BasicWorksheet & {
+    type: WorksheetType.LIST;
+    header: string;
+    content: (JkmdSheet | CodeEditorSheet | GraphSheet | QuizProblemSheet | QuizTextSheet | QuizOptionsSheet)[];
+    children: ListSheet[];
+};
+export type NewPageSheet = BasicWorksheet & {
+    type: WorksheetType.NEW_PAGE;
+};
+export type BodyWorksheet = JkmdSheet | CodeEditorSheet | ListSheet | GraphSheet | QuizProblemSheet | QuizTextSheet | QuizOptionsSheet | NewPageSheet;

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

@@ -0,0 +1,49 @@
+import { RecordId } from './commons';
+export declare enum WebSocketMessageEvent {
+    PING = "PING",
+    CLIENT_TRACK_LOCATION = "CLIENT_TRACK_LOCATION",
+    CLIENT_TRACK_SCREENSHOT = "CLIENT_TRACK_SCREENSHOT",
+    CLIENT_TRACK_DEVICE = "CLIENT_TRACK_DEVICE",
+    CHAT_COMPLETIONS = "CHAT_COMPLETIONS"
+}
+export declare enum WebSocketSubscriptionEvent {
+    SUBSCRIBE_CODE_RUN_STATUS = "SUBSCRIBE_CODE_RUN_STATUS",
+    UNSUBSCRIBE_CODE_RUN_STATUS = "UNSUBSCRIBE_CODE_RUN_STATUS",
+    SUBSCRIBE_SUBMISSION_RUN_STATUS = "SUBSCRIBE_SUBMISSION_RUN_STATUS",
+    UNSUBSCRIBE_SUBMISSION_RUN_STATUS = "UNSUBSCRIBE_SUBMISSION_RUN_STATUS",
+    SUBSCRIBE_GET_DATA = "SUBSCRIBE_GET_DATA",
+    UNSUBSCRIBE_GET_DATA = "SUBSCRIBE_GET_DATA",
+    SUBSCRIBE_PROBLEM_CRAWLED = "SUBSCRIBE_PROBLEM_CRAWLED",
+    UNSUBSCRIBE_PROBLEM_CRAWLED = "UNSUBSCRIBE_PROBLEM_CRAWLED",
+    SUBSCRIBE_SUBMISSIONS_CRAWL = "SUBSCRIBE_SUBMISSIONS_CRAWL",
+    UNSUBSCRIBE_SUBMISSIONS_CRAWL = "UNSUBSCRIBE_SUBMISSIONS_CRAWL",
+    SUBSCRIBE_CONTEST_CHANGES = "SUBSCRIBE_CONTEST_CHANGES",
+    UNSUBSCRIBE_CONTEST_CHANGES = "UNSUBSCRIBE_CONTEST_CHANGES",
+    SUBSCRIBE_CLIENT_TRACK = "SUBSCRIBE_CLIENT_TRACK",
+    UNSUBSCRIBE_CLIENT_TRACK = "UNSUBSCRIBE_CLIENT_TRACK",
+    SUBSCRIBE_USER_NOTIFICATION = "SUBSCRIBE_USER_NOTIFICATION",
+    UNSUBSCRIBE_USER_NOTIFICATION = "UNSUBSCRIBE_USER_NOTIFICATION"
+}
+export declare enum WebSocketResponseEvent {
+    PONG = "PONG",
+    CODE_RUN_STATUS = "CODE_RUN_STATUS",
+    SUBMISSION_RUN_STATUS = "SUBMISSION_RUN_STATUS",
+    USER_MESSAGE = "USER_MESSAGE",
+    SEND_DATA_ = "SEND_DATA_",
+    SEND_DATA_ECS_TASK_DEFINITIONS_LIST = "SEND_DATA_ECS_TASK_DEFINITIONS_LIST",
+    SEND_DATA_ECS_TASKS_LIST = "SEND_DATA_ECS_TASKS_LIST",
+    SEND_DATA_EC2_INSTANCES_LIST = "SEND_DATA_EC2_INSTANCES_LIST",
+    SEND_DATA_SSM_SESSIONS_LIST = "SEND_DATA_SSM_SESSIONS_LIST",
+    SEND_DATA_RUN_COMMAND = "SEND_DATA_RUN_COMMAND",
+    SEND_DATA_CLIENT_TRACK = "SEND_DATA_CLIENT_TRACK",
+    SEND_DATA_CHAT_COMPLETIONS = "SEND_DATA_CHAT_COMPLETIONS",
+    PROBLEM_CRAWLED = "PROBLEM_CRAWLED",
+    SUBMISSIONS_CRAWL = "SUBMISSIONS_CRAWL",
+    CONTEST_CHANGES = "CONTEST_CHANGES",
+    CLIENT_TRACK = "CLIENT_TRACK",
+    USER_NOTIFICATION_ = "USER_NOTIFICATION_",
+    USER_NOTIFICATION_SUBMISSION = "USER_NOTIFICATION_SUBMISSION",
+    USER_NOTIFICATION_CONTEST_CLARIFICATION = "USER_NOTIFICATION_CONTEST_CLARIFICATION"
+}
+export type ClientId = `${RecordId}|${string}`;
+export type WebSocketResponseEventKey = `${WebSocketResponseEvent}-${ClientId}-${string}`;

package/dist/types/types/submission.d.ts

@@ -0,0 +1,5 @@
+export type DataLog = {
+    timeUsed: number;
+    memoryUsed: number;
+    exitCode: number;
+};

package/dist/types/types/teams.d.ts

@@ -0,0 +1,73 @@
+import { MemberRole, AssignmentType, TeamStatus, UserTeamStatus } from './prisma';
+import { UserBasic, UserProfile } from './users';
+export interface TeamMember {
+    user: UserProfile;
+    role: MemberRole;
+    status: UserTeamStatus;
+}
+export interface Assignment {
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+    users: [];
+    name: string;
+    type: AssignmentType;
+    content: string;
+}
+export interface Comment {
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+    comment: string;
+}
+export interface Task {
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+    comments: Comment[];
+    assigned: UserBasic[];
+    subtasks: [];
+    title: string;
+    description: string;
+    dueDate: Date;
+}
+export interface Training {
+    id: number;
+    tasks: Task[];
+    name: string;
+    startDate: Date;
+    endDate: Date;
+}
+export interface Team {
+    id: number;
+    createdAt: Date;
+    name: string;
+    aboutTeam: string;
+    country: string;
+    city: string;
+    institution: string;
+    imageUrl: string;
+    status: TeamStatus;
+    members: TeamMember[];
+    training: Training[];
+}
+export interface TrainingBasic {
+    id: number;
+    numberOfTasks: number;
+    name: string;
+    startDate: Date;
+    endDate: Date;
+}
+export interface TeamBasic {
+    id: number;
+    createdAt: Date;
+    name: string;
+    aboutTeam: string;
+    country: string;
+    city: string;
+    institution: string;
+    imageUrl: string;
+    status: TeamStatus;
+    members: TeamMember[];
+    training: Training[];
+}

package/dist/types/types/users.d.ts

@@ -0,0 +1,59 @@
+import { ProfileSetting } from './account';
+import { CourseRole, Language, SystemRole, TeamRole, Theme, UserRole } from './prisma';
+export interface UserBasicInfo {
+    nickname: string;
+    imageUrl: string;
+}
+export interface UserBasic extends UserBasicInfo {
+    givenName: string;
+    familyName: string;
+    email: string;
+}
+export interface UserProfile extends UserBasic {
+    aboutMe: string;
+    country: string;
+    city: string;
+    institution: string;
+    telegramUsername: string;
+}
+export type UserHandles = {
+    [key: string]: string;
+};
+export declare enum DataViewMode {
+    CARDS = "CARDS",
+    ROWS = "ROWS"
+}
+export declare enum MenuViewMode {
+    HORIZONTAL = "HORIZONTAL",
+    VERTICAL = "VERTICAL"
+}
+export type UserSettings = {
+    [ProfileSetting.LANGUAGE]: Language;
+    [ProfileSetting.THEME]: Theme;
+    [ProfileSetting.DATA_VIEW_MODE]: DataViewMode;
+    [ProfileSetting.MENU_VIEW_MODE]: MenuViewMode;
+    [ProfileSetting.NEWSLETTER_SUBSCRIPTION]: boolean;
+    [ProfileSetting.TIME_ZONE]: string;
+    [ProfileSetting.FONT_SIZE]: number;
+};
+export declare enum Role {
+    SUPER_ADMIN = "SUPER_ADMIN",
+    ADMIN = "ADMIN",
+    MASTER = "MASTER",
+    MANAGER = "MANAGER",
+    CREATOR = "CREATOR",
+    REGULAR = "REGULAR",
+    LIMITED = "LIMITED",
+    GUEST = "GUEST",
+    RESTRICTED = "RESTRICTED"
+}
+export type ProblemRole = Role.RESTRICTED | Role.GUEST | Role.REGULAR | Role.CREATOR | Role.MANAGER | Role.MASTER | Role.ADMIN | Role.SUPER_ADMIN;
+export type ContestRole = Role.RESTRICTED | Role.GUEST | Role.REGULAR | Role.CREATOR | Role.MANAGER | Role.MASTER | Role.ADMIN | Role.SUPER_ADMIN;
+export type UserRoles = {
+    systemRole: SystemRole;
+    userRole: UserRole;
+    contestRole: ContestRole;
+    problemRole: ProblemRole;
+    teamRole: TeamRole;
+    courseRole: CourseRole;
+};

package/dist/types/types/virtual-user.d.ts

@@ -0,0 +1,7 @@
+export declare enum WorkingIn {
+    NOTHING = "NOTHING",
+    SEND_SUBMISSION = "SEND_SUBMISSION",
+    TRACKING_SUBMISSION = "TRACKING_SUBMISSION",
+    CRAWLING_LANGUAGES = "CRAWLING_LANGUAGES",
+    CRAWLING_PROBLEM_DATA = "CRAWLING_PROBLEM_DATA"
+}

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

@@ -0,0 +1,42 @@
+import { EntityMembers } from './entity';
+import { Theme } from './prisma';
+import { BasicWorksheet, BodyWorksheet, NewPageSheet } from './sheet';
+export declare enum AspectRatio {
+    RATIO_21_9 = "21:9",
+    RATIO_20_9 = "20:9",
+    RATIO_16_9 = "16:9",
+    RATIO_16_10 = "16:10",
+    RATIO_3_2 = "3:2",
+    RATIO_4_3 = "4:3",
+    RATIO_5_4 = "5:4",
+    RATIO_1_1 = "1:1"
+}
+export interface WorksheetBaseDocument {
+    key: string;
+    folderId: string;
+    name: string;
+    description: string;
+    content: BodyWorksheet[];
+    members: EntityMembers;
+    quiz: {
+        enable: boolean;
+        automaticFeedback: boolean;
+    };
+    slides: {
+        enable: boolean;
+        titleBackgroundImage: string;
+        backgroundImage: string;
+        fontSize: number;
+        theme: Theme;
+        colorTextHighlight: string;
+        aspectRatio: AspectRatio;
+    };
+}
+export type WorksheetsInPages = {
+    header: NewPageSheet;
+    content: BodyWorksheet[];
+}[];
+export type SummaryWorksheetsInPages = {
+    header: NewPageSheet;
+    content: BasicWorksheet[];
+}[];

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@juki-team/commons",
+  "version": "0.1.11",
+  "author": "juki-team",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs"
+    }
+  },
+  "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"
+  },
+  "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"
+  }
+}