@vestcards/shared 1.3.0 → 1.4.0

package/dist/spaced-repetition.d.ts

@@ -1,5 +1,9 @@
 import { Card } from 'ts-fsrs';
 
+export declare function calculateRetentionPercentage(elapsedDays: number, stability: number): number;
+
+export declare function calculateRetrievability(elapsedDays: number, stability: number): number;
+
 export declare const defaultSessionData: ISessionData;
 
 /**
@@ -22,6 +26,10 @@ export declare class FlashcardSessionManager {
 
 export declare const FSRS_RETENTION = 0.9;
 
+export declare const FSRS_RETENTION_FACTOR: number;
+
+export declare const FSRS_RETRIEVABILITY_DECAY = 0.1542;
+
 export declare function getNextCardFromSession(data: ISessionData, recentlyReviewed?: Set<string>): ISessionCard | undefined;
 
 /**
@@ -97,6 +105,8 @@ declare interface ISessionData {
     stats: IStudyStats;
 }
 
+export declare const isRecommendedLearningSettings: (learnDailyLimit: number | null, newCardsPerDeckDailyLimit: number | null) => boolean;
+
 declare interface IStudyStats {
     review: number;
     learning: number;
@@ -104,11 +114,22 @@ declare interface IStudyStats {
     total: number;
 }
 
-export declare const MAX_CARDS_TO_FETCH = 50;
-
-export declare const MAX_LEARN_PER_DAY = 200;
+export declare const LEARNING_SETTINGS_LIMITS: {
+    readonly learnDailyLimit: {
+        readonly recommended: 200;
+        readonly min: 100;
+        readonly max: 500;
+        readonly step: 50;
+    };
+    readonly newCardsPerDeckDailyLimit: {
+        readonly recommended: 10;
+        readonly min: 1;
+        readonly max: 50;
+        readonly step: 5;
+    };
+};
 
-export declare const MAX_NEW_PER_DECK_DAY = 10;
+export declare const MAX_CARDS_TO_FETCH = 50;
 
 export declare function mergeFsrsCard(fsrsCard: Card, card: ICardReview): ICardReview;