@vestcards/server-types 0.5.0 → 1.0.0

package/dist/apps/server/src/app.d.ts

@@ -530,7 +530,7 @@ declare const app: Elysia<"", {
                     };
                     headers: {};
                     response: {
-                        200: import("./types/study").SessionData;
+                        200: import("@vestcards/shared").ISessionData;
                         422: {
                             type: "validation";
                             on: string;
@@ -558,7 +558,7 @@ declare const app: Elysia<"", {
                     };
                     headers: {};
                     response: {
-                        200: import("@vestcards/shared").SessionStats | {
+                        200: import("@vestcards/shared").IStudyStats | {
                             status: import("@vestcards/shared").StudyStatus;
                             review: number;
                             learning: number;
@@ -624,7 +624,7 @@ declare const app: Elysia<"", {
                 query: {};
                 headers: {};
                 response: {
-                    200: import("@vestcards/shared").GroupedLibraryData;
+                    200: import("@vestcards/shared").IGroupedLibraryData;
                 };
             };
         };
@@ -639,7 +639,7 @@ declare const app: Elysia<"", {
                     query: {};
                     headers: {};
                     response: {
-                        200: import("@vestcards/shared").ArchivedLibraryItem[];
+                        200: import("@vestcards/shared").IArchivedLibraryItem[];
                     };
                 };
             };

package/dist/apps/server/src/db/schema/deck.d.ts

@@ -1019,7 +1019,7 @@ export declare const reviewLogs: import("drizzle-orm/pg-core").PgTableWithColumn
             tableName: "review_log";
             dataType: "string";
             columnType: "PgText";
-            data: "Again" | "Hard" | "Good" | "Easy" | "Manual";
+            data: "Manual" | "Again" | "Hard" | "Good" | "Easy";
             driverParam: string;
             notNull: true;
             hasDefault: false;

package/dist/apps/server/src/modules/library/index.d.ts

@@ -357,7 +357,7 @@ export declare const libraryModule: Elysia<"/v1/library", {
                 query: {};
                 headers: {};
                 response: {
-                    200: import("@vestcards/shared").GroupedLibraryData;
+                    200: import("@vestcards/shared").IGroupedLibraryData;
                 };
             };
         };
@@ -372,7 +372,7 @@ export declare const libraryModule: Elysia<"/v1/library", {
                     query: {};
                     headers: {};
                     response: {
-                        200: import("@vestcards/shared").ArchivedLibraryItem[];
+                        200: import("@vestcards/shared").IArchivedLibraryItem[];
                     };
                 };
             };

package/dist/apps/server/src/modules/library/service.d.ts

@@ -1,7 +1,7 @@
-import type { ArchivedLibraryItem, GroupedLibraryData } from '@vestcards/shared';
+import type { IArchivedLibraryItem, IGroupedLibraryData } from '@vestcards/shared';
 export declare abstract class LibraryService {
-    static getGroupedLibraryData(userId: string): Promise<GroupedLibraryData>;
-    static getArchivedLibraryData(userId: string): Promise<ArchivedLibraryItem[]>;
+    static getGroupedLibraryData(userId: string): Promise<IGroupedLibraryData>;
+    static getArchivedLibraryData(userId: string): Promise<IArchivedLibraryItem[]>;
     static startDeckStudy(userId: string, deckId: string): Promise<void>;
     static deleteDeckStudy(userId: string, deckId: string): Promise<void>;
     static updateDeckStudySuspended(userId: string, deckId: string, suspended: boolean): Promise<void>;

package/dist/apps/server/src/modules/study/index.d.ts

@@ -361,7 +361,7 @@ export declare const studyModule: Elysia<"/v1/study", {
                     };
                     headers: {};
                     response: {
-                        200: import("../../types/study").SessionData;
+                        200: import("@vestcards/shared").ISessionData;
                         422: {
                             type: "validation";
                             on: string;
@@ -389,7 +389,7 @@ export declare const studyModule: Elysia<"/v1/study", {
                     };
                     headers: {};
                     response: {
-                        200: import("@vestcards/shared").SessionStats | {
+                        200: import("@vestcards/shared").IStudyStats | {
                             status: import("@vestcards/shared").StudyStatus;
                             review: number;
                             learning: number;

package/dist/apps/server/src/modules/study/service.d.ts

@@ -1,13 +1,13 @@
+import type { ISessionData, IStudyStats, StudyType } from '@vestcards/shared';
 import { type CardReview } from '../../db/schema/deck';
-import type { SessionData, SessionStats, StudyType } from '../../types/study';
 import type { StudyModel } from './model';
 export declare abstract class StudyService {
-    static getSessionData(userId: string, type: StudyType, id?: string): Promise<SessionData>;
+    static getSessionData(userId: string, type: StudyType, id?: string): Promise<ISessionData>;
     static getNumberLeftToLearnToday(userId: string, date?: Date): Promise<number>;
     static getStats(userId: string, numLeftToLearn: number, // capacity left today (from the function above)
-    type: StudyType, id?: string): Promise<SessionStats>;
-    static getReviewCards(userId: string, type: StudyType, id?: string, maxToFetch?: number): Promise<import("../../types/study").SessionCard[]>;
-    static getNewCards(userId: string, allocatedNewForToday: number, type: StudyType, id?: string): Promise<import("../../types/study").SessionCard[]>;
+    type: StudyType, id?: string): Promise<IStudyStats>;
+    static getReviewCards(userId: string, type: StudyType, id?: string, maxToFetch?: number): Promise<import("@vestcards/shared").ISessionCard[]>;
+    static getNewCards(userId: string, allocatedNewForToday: number, type: StudyType, id?: string): Promise<import("@vestcards/shared").ISessionCard[]>;
     static getUserDeckStudy(userId: string, deckId: string): Promise<{
         suspended: boolean;
         id: string;

package/dist/apps/server/src/modules/study/utils.d.ts

@@ -1,5 +1,4 @@
-import type { SessionStats, StudyStatus } from '@vestcards/shared';
-import type { SessionCard, StudyType } from 'src/types/study';
+import type { ISessionCard, IStudyStats, StudyStatus, StudyType } from '@vestcards/shared';
 import type { SessionCardSelect } from 'src/utils/select';
 export declare const getSessionFilterByStudyType: (type: StudyType, id?: string) => import("drizzle-orm").SQL<unknown> | undefined;
 export declare const allocateByPriority: (capacityLeft: number, counts: {
@@ -12,7 +11,7 @@ export declare const allocateByPriority: (capacityLeft: number, counts: {
     new: number;
     total: number;
 };
-export declare function getStudyStatus(stats: SessionStats, userDeckStudy: {
+export declare function getStudyStatus(stats: IStudyStats, userDeckStudy: {
     suspended: boolean;
 } | undefined): StudyStatus;
-export declare function sessionCardToICard(sessionRows: SessionCardSelect[]): SessionCard[];
+export declare function sessionCardToICard(sessionRows: SessionCardSelect[]): ISessionCard[];

package/dist/apps/server/src/modules/topic/service.d.ts

@@ -1,4 +1,4 @@
-import type { Topic } from 'src/types/topic';
+import type { Topic } from '@vestcards/shared';
 import { type Paginated } from 'src/utils/api';
 import type { TopicModel } from './model';
 export declare abstract class TopicService {

package/dist/apps/server/src/utils/select.d.ts

@@ -1,5 +1,5 @@
 import type { Subject } from '@vestcards/shared';
-import { type InferColumnsDataTypes } from 'drizzle-orm';
+import type { CardReview } from '../db/schema/deck';
 export declare const sessionCardSelect: {
     card: {
         id: import("drizzle-orm/pg-core").PgColumn<{
@@ -364,7 +364,7 @@ export type SessionCardSelect = {
     subject: Subject;
     topicName: string;
     userDeckStudyId: string;
-    cardReview: InferColumnsDataTypes<typeof sessionCardSelect.cardReview> | null;
+    cardReview: Omit<CardReview, 'cardId' | 'userDeckStudyId'> | null;
 };
 export declare const statsSelect: {
     new: import("drizzle-orm").SQL<number>;

package/dist/packages/shared/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/deck';
+export * from './types/fsrs';
 export * from './types/study';
 export * from './types/subject';
 export * from './types/topic';

package/dist/packages/shared/src/types/fsrs.d.ts

@@ -0,0 +1,17 @@
+export declare enum ReviewState {
+    New = "New",
+    Learning = "Learning",
+    Review = "Review",
+    Relearning = "Relearning"
+}
+export declare const reviewStates: readonly ["New", "Learning", "Review", "Relearning"];
+export type ReviewStateType = keyof typeof ReviewState;
+export declare enum ReviewRating {
+    Manual = "Manual",
+    Again = "Again",
+    Hard = "Hard",
+    Good = "Good",
+    Easy = "Easy"
+}
+export declare const reviewRatings: readonly ["Manual", "Again", "Hard", "Good", "Easy"];
+export type ReviewRatingType = keyof typeof ReviewRating;

package/dist/packages/shared/src/types/study.d.ts

@@ -1,29 +1,63 @@
+import type { ICard, Subject } from './deck';
+import type { ReviewRating, ReviewState } from './fsrs';
 export type StudyType = 'ALL' | 'DECK' | 'TOPIC' | 'SUBJECT';
-export type Rating = 'Again' | 'Hard' | 'Good' | 'Easy';
-export type CardState = 'New' | 'Learning' | 'Review' | 'Relearning';
-export interface SessionStats {
+export interface ICardReview {
+    id: string;
+    due: Date | null;
+    stability: number;
+    difficulty: number;
+    elapsedDays: number;
+    scheduledDays: number;
+    reps: number;
+    lapses: number;
+    state: ReviewState;
+    lastReview: Date | null;
+    userDeckStudyId: string;
+    cardId: string;
+}
+export interface IReviewLog {
+    id: number;
+    cardReviewId: string;
+    grade: ReviewRating;
+    state: ReviewState;
+    due: Date;
+    stability: number;
+    difficulty: number;
+    elapsedDays: number;
+    lastElapsedDays: number;
+    scheduledDays: number;
+    review: Date;
+    duration: number;
+}
+export interface ISessionCard {
+    card: ICard;
+    cardReview: ICardReview;
+    subject: Subject;
+    topicName: string;
+    userDeckStudyId: string;
+}
+export interface ISessionData {
+    reviewCards: ISessionCard[];
+    newCards: ISessionCard[];
+    stats: IStudyStats;
+}
+export interface IStudyStats {
     review: number;
     learning: number;
     new: number;
     total: number;
 }
-export interface GradeCardInput {
-    cardId: string;
-    userDeckStudyId: string;
-    grade: Rating;
-    reviewDurationInSeconds: number;
-}
-export interface GroupedLibraryItem {
+export type StudyStatus = 'not-started' | 'suspended' | 'has-cards' | 'no-cards';
+export interface IGroupedLibraryItem {
     name: string;
     id: string;
     ownerId?: string;
     type: StudyType;
-    stats: SessionStats;
-    subRows?: GroupedLibraryItem[];
+    stats: IStudyStats;
+    subRows?: IGroupedLibraryItem[];
 }
-export type GroupedLibraryData = GroupedLibraryItem[];
-export type StudyStatus = 'not-started' | 'suspended' | 'has-cards' | 'no-cards';
-export interface ArchivedLibraryItem {
+export type IGroupedLibraryData = IGroupedLibraryItem[];
+export interface IArchivedLibraryItem {
     deckId: string;
     subject: string;
     topic: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vestcards/server-types",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "private": false,
   "types": "./dist/index.d.ts",
   "exports": {

package/dist/apps/server/src/types/study.d.ts

@@ -1,28 +0,0 @@
-import type { Subject } from '@vestcards/shared';
-import type { CardReview } from 'src/db/schema/deck';
-export type { CardState, GradeCardInput, Rating, SessionStats, StudyStatus, StudyType } from '@vestcards/shared';
-export interface ICard {
-    id: string;
-    question: string;
-    answer: string | null;
-    frontImage?: {
-        id: string;
-        url: string;
-    };
-    backImage?: {
-        id: string;
-        url: string;
-    };
-}
-export type SessionCard = {
-    card: ICard;
-    card_review: CardReview;
-    subject: Subject;
-    topicName: string;
-    userDeckStudyId: string;
-};
-export interface SessionData {
-    reviewCards: SessionCard[];
-    newCards: SessionCard[];
-    stats: import('@vestcards/shared').SessionStats;
-}

package/dist/apps/server/src/types/topic.d.ts

@@ -1 +0,0 @@
-export type { Topic } from '@vestcards/shared';