@shaxpir/duiduidui-models 1.5.2 → 1.5.3

package/dist/models/Review.d.ts

@@ -1,8 +1,8 @@
-import { MultiTime } from "@shaxpir/shaxpir-common";
+import { CompactDateTime } from "@shaxpir/shaxpir-common";
 export type ReviewResult = 'FAIL' | 'HARD' | 'GOOD' | 'EASY';
 export interface ReviewLike {
     result: ReviewResult;
-    at: MultiTime;
+    at_utc_time: CompactDateTime;
 }
 export interface Review extends ReviewLike {
     text: string;

package/dist/models/Session.d.ts

@@ -3,7 +3,6 @@ import { MultiTime } from "@shaxpir/shaxpir-common";
 import { ShareSync } from '../repo';
 import { Content, ContentBody, ContentId, ContentMeta, ContentRef } from "./Content";
 import { Review } from './Review';
-import { ArrayView } from './ArrayView';
 export interface SessionPayload {
     start: MultiTime;
     end: MultiTime;
@@ -11,6 +10,7 @@ export interface SessionPayload {
     device_id: ContentId;
     duration_minutes: number;
     reviews: Review[];
+    review_count: number;
 }
 export interface SessionBody extends ContentBody {
     meta: ContentMeta;
@@ -29,7 +29,8 @@ export declare class Session extends Content {
     get tzOffset(): number;
     get durationMinutes(): number;
     get deviceId(): ContentId;
-    get reviews(): ArrayView<Review>;
-    modelUpdated(): Promise<void>;
+    get reviews(): Review[];
+    get reviewCount(): number;
     addReview(review: Review): void;
+    modelUpdated(): Promise<void>;
 }

package/dist/models/Session.js

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Session = void 0;
 const shaxpir_common_1 = require("@shaxpir/shaxpir-common");
 const repo_1 = require("../repo");
+const ArrayView_1 = require("./ArrayView");
 const Content_1 = require("./Content");
 const ContentKind_1 = require("./ContentKind");
 const Metric_1 = require("./Metric");
 const Operation_1 = require("./Operation");
 const Workspace_1 = require("./Workspace");
-const ArrayView_1 = require("./ArrayView");
 class Session extends Content_1.Content {
     constructor(doc, shouldAcquire, shareSync) {
         super(doc, shouldAcquire, shareSync);
@@ -40,7 +40,8 @@ class Session extends Content_1.Content {
                 tz_offset: (new Date()).getTimezoneOffset(),
                 duration_minutes: 0,
                 device_id: deviceId,
-                reviews: []
+                reviews: [],
+                review_count: 0
             }
         });
     }
@@ -79,20 +80,41 @@ class Session extends Content_1.Content {
         this.checkDisposed("Session.deviceId");
         return this.payload.device_id;
     }
+    // NOTE: We are not offering a getter for the `_reviewsView` because ArrayView offers its own mutator
+    // methods (push, etc), and we don't want to circumvent the `addReview` method, which has important
+    // constraints and side effects.
     get reviews() {
-        this.checkDisposed("Session.reviews");
-        return this._reviewsView;
+        this.checkDisposed("Session.getReviews");
+        return this._reviewsView.values;
+    }
+    get reviewCount() {
+        this.checkDisposed("Session.getReviewCount");
+        return this._reviewsView.length;
+    }
+    addReview(review) {
+        this.checkDisposed("Session.addReview");
+        if (review.hasOwnProperty('context') && review.hasOwnProperty('weight')) {
+            throw new Error("Implied reviews cannot be added to a Session");
+        }
+        this._reviewsView.push({
+            text: review.text,
+            sense_rank: review.sense_rank,
+            result: review.result,
+            at_utc_time: review.at_utc_time
+        });
+        const batch = new Operation_1.BatchOperation(this);
+        batch.setPathValue(['payload', 'review_count'], this._reviewsView.length);
+        batch.commit();
     }
     async modelUpdated() {
         this.checkDisposed("Session.modelUpdated");
         await super.modelUpdated();
         const shareSync = this.shareSync;
-        const sessionId = this.id;
         const userId = this.owner;
         const date = shaxpir_common_1.Time.dateFrom(this.createdAt.local_time);
         const workspaceId = Workspace_1.Workspace.makeWorkspaceId(userId);
         const workspace = await this.shareSync.acquire(ContentKind_1.ContentKind.WORKSPACE, workspaceId);
-        const sessionsOnDate = await workspace.acquireSessionsFromDate(sessionId, date);
+        const sessionsOnDate = await workspace.acquireSessionsFromDate(date);
         workspace.release();
         let minutesStudyingOnDate = 0;
         let reviewCountOnDate = 0;
@@ -113,9 +135,5 @@ class Session extends Content_1.Content {
         reviewCountMetric.setDateAmount(date, reviewCountOnDate);
         reviewCountMetric.release();
     }
-    addReview(review) {
-        this.checkDisposed("Session.addReview");
-        this._reviewsView.push(review);
-    }
 }
 exports.Session = Session;

package/dist/models/Term.d.ts

@@ -1,10 +1,10 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
 import { CompactDateTime } from "@shaxpir/shaxpir-common";
+import { ShareSync } from '../repo';
 import { BayesianScore } from './BayesianScore';
 import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
 import { BuiltInPhrase, Phrase, PhraseExample } from './Phrase';
-import { ReviewLike } from "./Review";
-import { ShareSync } from '../repo';
+import { ImpliedReview, ReviewLike } from "./Review";
 export interface TermSummary {
     text: string;
     sense_rank: number;
@@ -16,6 +16,7 @@ export interface TermSummary {
     theta: number;
     uncertainty: number;
     review_count: number;
+    implied_review_count: number;
     last_review_utc: CompactDateTime;
 }
 export interface TermPayload extends BayesianScore {
@@ -32,6 +33,8 @@ export interface TermPayload extends BayesianScore {
     reviews: ReviewLike[];
     review_count: number;
     last_review_utc: CompactDateTime;
+    implied_reviews: ImpliedReview[];
+    implied_review_count: number;
     hanzi_count?: number;
     pinyin?: string;
     pinyin_tokenized?: string;
@@ -49,23 +52,26 @@ export interface TermBody extends ContentBody {
 export declare class Term extends Content {
     static makeTermId(userId: ContentId, text: string, senseRank: number): ContentId;
     private _reviewsView;
+    private _impliedReviewsView;
     constructor(doc: Doc, shouldAcquire: boolean, shareSync: ShareSync);
     static forUserPhrase(userId: ContentId, text: string, senseRank: number, difficulty: number, phraseId?: number): Term;
     static forUserPhrase(userId: ContentId, phrase: Phrase): Term;
     static forBuiltinPhrase(userId: ContentId, phrase: BuiltInPhrase): Term;
     get payload(): TermPayload;
-    getText(): string;
-    getSenseRank(): number;
-    getDifficulty(): number;
-    getAlpha(): number;
-    getBeta(): number;
-    getTheta(): number;
-    getUncertainty(): number;
-    getReviews(): ReviewLike[];
-    getStarredAt(): CompactDateTime | null;
+    get text(): string;
+    get senseRank(): number;
+    get difficulty(): number;
+    get alpha(): number;
+    get beta(): number;
+    get theta(): number;
+    get uncertainty(): number;
+    get starredAt(): CompactDateTime | null;
+    get lastReviewUtc(): CompactDateTime | null;
     setStarredAt(value: CompactDateTime | null): void;
     updateBayesianScore(alpha: number, beta: number, theta: number): void;
+    get reviews(): ReviewLike[];
+    get impliedReviews(): ImpliedReview[];
+    get reviewCount(): number;
+    get impliedReviewCount(): number;
     addReview(review: ReviewLike): void;
-    getReviewCount(): number;
-    getLastReviewUtc(): CompactDateTime | null;
 }

package/dist/models/Term.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Term = void 0;
 const shaxpir_common_1 = require("@shaxpir/shaxpir-common");
+const repo_1 = require("../repo");
+const ArrayView_1 = require("./ArrayView");
 const BayesianScore_1 = require("./BayesianScore");
 const Content_1 = require("./Content");
 const ContentKind_1 = require("./ContentKind");
-const repo_1 = require("../repo");
 const Operation_1 = require("./Operation");
-const ArrayView_1 = require("./ArrayView");
 class Term extends Content_1.Content {
     static makeTermId(userId, text, senseRank) {
         return shaxpir_common_1.CachingHasher.makeMd5Base62Hash(`${ContentKind_1.ContentKind.TERM}-${userId}-${text}-${senseRank}`);
@@ -15,6 +15,7 @@ class Term extends Content_1.Content {
     constructor(doc, shouldAcquire, shareSync) {
         super(doc, shouldAcquire, shareSync);
         this._reviewsView = new ArrayView_1.ArrayView(this, ['payload', 'reviews']);
+        this._impliedReviewsView = new ArrayView_1.ArrayView(this, ['payload', 'implied_reviews']);
     }
     static forUserPhrase(userId, textOrPhrase, senseRank, difficulty, phraseId) {
         const now = shaxpir_common_1.ClockService.getClock().now();
@@ -71,7 +72,9 @@ class Term extends Content_1.Content {
                 uncertainty: BayesianScore_1.BayesianScoreModel.calculateUncertainty(0.5, 0.5),
                 reviews: [],
                 review_count: 0,
-                last_review_utc: null
+                last_review_utc: null,
+                implied_reviews: [],
+                implied_review_count: 0,
             }
         });
     }
@@ -100,7 +103,9 @@ class Term extends Content_1.Content {
                 uncertainty: BayesianScore_1.BayesianScoreModel.calculateUncertainty(0.5, 0.5),
                 reviews: [],
                 review_count: 0,
-                last_review_utc: null
+                last_review_utc: null,
+                implied_reviews: [],
+                implied_review_count: 0,
             }
         });
     }
@@ -108,42 +113,42 @@ class Term extends Content_1.Content {
         this.checkDisposed("Term.payload");
         return this.doc.data.payload;
     }
-    getText() {
-        this.checkDisposed("Term.getText");
+    get text() {
+        this.checkDisposed("Term.text");
         return this.payload.text;
     }
-    getSenseRank() {
-        this.checkDisposed("Term.getSenseRank");
+    get senseRank() {
+        this.checkDisposed("Term.senseRank");
         return this.payload.sense_rank;
     }
-    getDifficulty() {
-        this.checkDisposed("Term.getDifficulty");
+    get difficulty() {
+        this.checkDisposed("Term.difficulty");
         return this.payload.difficulty;
     }
-    getAlpha() {
-        this.checkDisposed("Term.getAlpha");
+    get alpha() {
+        this.checkDisposed("Term.alpha");
         return this.payload.alpha;
     }
-    getBeta() {
-        this.checkDisposed("Term.getBeta");
+    get beta() {
+        this.checkDisposed("Term.beta");
         return this.payload.beta;
     }
-    getTheta() {
-        this.checkDisposed("Term.getTheta");
+    get theta() {
+        this.checkDisposed("Term.theta");
         return this.payload.theta;
     }
-    getUncertainty() {
-        this.checkDisposed("Term.getUncertainty");
+    get uncertainty() {
+        this.checkDisposed("Term.uncertainty");
         return this.payload.uncertainty;
     }
-    getReviews() {
-        this.checkDisposed("Term.getReviews");
-        return this.payload.reviews;
-    }
-    getStarredAt() {
-        this.checkDisposed("Term.getStarredAt");
+    get starredAt() {
+        this.checkDisposed("Term.starredAt");
         return this.payload.starred_at;
     }
+    get lastReviewUtc() {
+        this.checkDisposed("Term.lastReviewUtc");
+        return this.payload.last_review_utc;
+    }
     setStarredAt(value) {
         this.checkDisposed("Term.setStarredAt");
         if (this.payload.starred_at !== value) {
@@ -161,34 +166,56 @@ class Term extends Content_1.Content {
         batch.setPathValue(['payload', 'uncertainty'], BayesianScore_1.BayesianScoreModel.calculateUncertainty(alpha, beta));
         batch.commit();
     }
+    // NOTE: We are not offering a getter for the `_reviewsView` because ArrayView offers its own mutator
+    // methods (push, etc), and we don't want to circumvent the `addReview` method, which has important
+    // constraints and side effects.
+    get reviews() {
+        this.checkDisposed("Session.reviews");
+        return this._reviewsView.values;
+    }
+    // NOTE: We are not offering a getter for the `_impliedReviewsView` because ArrayView offers its own
+    // mutator methods (push, etc), and we don't want to circumvent the `addReview` method, which has
+    // important constraints and side effects.
+    get impliedReviews() {
+        this.checkDisposed("Term.impliedReviews");
+        return this._impliedReviewsView.values;
+    }
+    get reviewCount() {
+        this.checkDisposed("Term.reviewCount");
+        return this.payload.review_count;
+    }
+    get impliedReviewCount() {
+        this.checkDisposed("Term.impliedReviewCount");
+        return this.payload.implied_review_count;
+    }
+    // Add either an implied or explicit review
     addReview(review) {
         this.checkDisposed("Term.addReview");
-        this._reviewsView.push(review);
-        // Count reviews again.
-        let reviewCount = 0;
-        let lastReviewUtc = null;
-        this._reviewsView.forEach((idx, r) => {
-            // We only count *actual* reviews, not implied reviews...
-            if (!r.hasOwnProperty('context') && !r.hasOwnProperty('weight')) {
-                const reviewUtc = r.at.utc_time;
-                if (!lastReviewUtc || shaxpir_common_1.Time.isDateTimeAfter(reviewUtc, lastReviewUtc)) {
-                    lastReviewUtc = reviewUtc;
-                }
-                reviewCount++;
+        if (review.hasOwnProperty('context') &&
+            review.hasOwnProperty('weight')) {
+            const r = review;
+            this._impliedReviewsView.push({
+                result: r.result,
+                at_utc_time: r.at_utc_time,
+                context: r.context,
+                weight: r.weight
+            });
+            const batch = new Operation_1.BatchOperation(this);
+            batch.setPathValue(['payload', 'implied_review_count'], this._impliedReviewsView.length);
+            batch.commit();
+        }
+        else {
+            this._reviewsView.push({
+                result: review.result,
+                at_utc_time: review.at_utc_time
+            });
+            const batch = new Operation_1.BatchOperation(this);
+            batch.setPathValue(['payload', 'review_count'], this._reviewsView.length);
+            if (this.lastReviewUtc == null || shaxpir_common_1.Time.isDateTimeAfter(review.at_utc_time, this.lastReviewUtc)) {
+                batch.setPathValue(['payload', 'last_review_utc'], review.at_utc_time);
             }
-        });
-        const batch = new Operation_1.BatchOperation(this);
-        batch.setPathValue(['payload', 'review_count'], reviewCount);
-        batch.setPathValue(['payload', 'last_review_utc'], lastReviewUtc);
-        batch.commit();
-    }
-    getReviewCount() {
-        this.checkDisposed("Term.getReviewCount");
-        return this.payload.review_count;
-    }
-    getLastReviewUtc() {
-        this.checkDisposed("Term.getLastReviewUtc");
-        return this.payload.last_review_utc;
+            batch.commit();
+        }
     }
 }
 exports.Term = Term;

package/dist/models/Workspace.d.ts

@@ -31,7 +31,8 @@ export declare class Workspace extends Content {
     static create(userId: ContentId, payload: WorkspacePayload): Workspace;
     get sessions(): ArrayView<MultiTime>;
     get devices(): ArrayView<ContentId>;
-    acquireSessionsFromDate(sessionId: ContentId, localDate: CompactDate): Promise<Session[]>;
+    acquireSessionForUtcTime(utcTime: CompactDateTime): Promise<Session | null>;
+    acquireSessionsFromDate(localDate: CompactDate): Promise<Session[]>;
     hasJourneyDate(journeyKey: string): boolean;
     getJourneyDate(journeyKey: string): CompactDateTime;
     setJourneyDate(journeyKey: string, journeyDate: CompactDateTime): void;

package/dist/models/Workspace.js

@@ -49,7 +49,26 @@ class Workspace extends Content_1.Content {
         this.checkDisposed("Workspace.devices");
         return this._devicesView;
     }
-    async acquireSessionsFromDate(sessionId, localDate) {
+    async acquireSessionForUtcTime(utcTime) {
+        this.checkDisposed("Workspace.acquireSessionForUtcTime");
+        const shareSync = repo_1.ShareSyncFactory.get();
+        for (let i = 0, len = this.sessions.length; i < len; i++) {
+            const sessionCreatedAt = this.sessions.get(i);
+            if (shaxpir_common_1.Time.isDateTimeBefore(sessionCreatedAt.utc_time, utcTime)) {
+                const sessionRef = Session_1.Session.makeSessionRef(this.owner, sessionCreatedAt);
+                const session = await shareSync.acquire(ContentKind_1.ContentKind.SESSION, sessionRef);
+                const sessionUpdatedAt = session.updatedAt;
+                if (shaxpir_common_1.Time.isDateTimeAfter(sessionUpdatedAt.utc_time, utcTime)) {
+                    return session;
+                }
+                else {
+                    session.release();
+                }
+            }
+        }
+        return null;
+    }
+    async acquireSessionsFromDate(localDate) {
         this.checkDisposed("Workspace.loadSessionsFromDate");
         const shareSync = repo_1.ShareSyncFactory.get();
         const sessions = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shaxpir/duiduidui-models",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/shaxpir/duiduidui-models"