@shaxpir/duiduidui-models 1.3.2 → 1.3.3

package/lib/models/Profile.ts

@@ -1,117 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CachingHasher, MultiClock } from '@shaxpir/shaxpir-common';
-import { ShareSync, ShareSyncFactory } from '../repo';
-import { Content, ContentBody, ContentId, ContentMeta, ContentRef } from "./Content";
-import { ContentKind } from './ContentKind';
-import { MediaCropping } from './Media';
-import { BatchOperation } from './Operation';
-
-export interface ProfilePayload {
-  username:string;
-  full_name:string;
-  avatar_media_ref:ContentId;
-  avatar_cropping:MediaCropping;
-}
-
-export interface ProfileBody extends ContentBody {
-  meta:ContentMeta;
-  payload:ProfilePayload;
-}
-
-export class Profile extends Content {
-
-  public static makeProfileId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind.PROFILE) as ContentId;
-  }
-
-  public static create(userId:ContentId):Profile {
-    const now = MultiClock.now();
-    const profileId = Profile.makeProfileId(userId);
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : profileId,
-          kind : ContentKind.PROFILE,
-          id : profileId,
-          owner : userId,
-          created_at : now,
-          updated_at : now
-        },
-        payload : {
-          username : null,
-          full_name : '',
-          avatar_media_ref : null as ContentRef,
-          avatar_cropping : null
-        }
-      }
-    ) as Profile;
-  }
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-  }
-
-  public get payload():ProfilePayload {
-    this.checkDisposed("Profile.payload");
-    return this.doc.data.payload as ProfilePayload;
-  }
-
-  public get username():string {
-    this.checkDisposed("Profile.username");
-    return this.payload.username;
-  }
-  public setUsername(value:string) {
-    this.checkDisposed("Profile.setUsername");
-    if (this.username != value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'username' ] , value);
-      batch.commit();
-    }
-  }
-
-  public get fullName():string {
-    this.checkDisposed("Profile.fullName");
-    return this.payload.full_name;
-  }
-  public setFullName(value:string) {
-    this.checkDisposed("Profile.setFullName");
-    if (this.fullName !== value) {
-      const batch = new BatchOperation(this);
-      batch.editPathText([ 'payload', 'full_name' ] , value);
-      batch.commit();
-    }
-  }
-
-  public get avatarMediaRef():ContentId {
-    this.checkDisposed("Profile.avatarMediaRef");
-    return this.payload.avatar_media_ref;
-  }
-  public setAvatarMediaRef(value:ContentId) {
-    this.checkDisposed("Profile.setAvatarMediaRef");
-    if (this.avatarMediaRef !== value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'avatar_media_ref' ] , value);
-      batch.commit();
-    }
-  }
-
-  public get avatarCropping():MediaCropping {
-    this.checkDisposed("Profile.avatarCropping");
-    return this.payload.avatar_cropping;
-  }
-  public setAvatarCropping(value:MediaCropping) {
-    this.checkDisposed("Profile.setAvatarCropping");
-    if (this.avatarCropping !== value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'avatar_cropping' ] , value);
-      batch.commit();
-    }
-  }
-
-  public static async findByUsername(username:string):Promise<Profile[]> {
-    const shareSync = ShareSyncFactory.get();
-    return shareSync.findAndAcquire(
-      ContentKind.PROFILE, { "payload.username" : username }
-    ) as Promise<Profile[]>;
-  }
-}

package/lib/models/Progress.ts

@@ -1,101 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CachingHasher, CompactDateTime, MultiClock } from "@shaxpir/shaxpir-common";
-import { ShareSync, ShareSyncFactory } from '../repo';
-import { BayesianScore } from './BayesianScore';
-import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
-import { ContentKind } from './ContentKind';
-import { BatchOperation } from './Operation';
-
-export interface PhraseProgress extends BayesianScore {
-  text:string;
-  sense_rank:number;
-  learn_rank: number;
-  last_review_utc?: CompactDateTime;
-}
-
-// The Proficiency model represents our assessment of the user's overall language level (user_rank)
-// as well as a map of phrases with their learn_rank, alpha, beta, and pr
-export interface ProgressPayload {
-  user_rank:number;
-  phrases:Record<string, PhraseProgress>;
-  cognitive_load:number;
-}
-
-export interface ProgressBody extends ContentBody {
-  meta:ContentMeta;
-  payload:ProgressPayload;
-}
-
-export class Progress extends Content {
-
-  public static makeProgressId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind.PROGRESS) as ContentId;
-  }
-
-  public static create(
-    userId:ContentId
-  ):Progress {
-    const now = MultiClock.now();
-    const progressId = Progress.makeProgressId(userId);
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : progressId,
-          kind : ContentKind.PROGRESS,
-          id : progressId,
-          owner : userId,
-          created_at : now,
-          updated_at : now
-        },
-        payload : {
-          user_rank : 0,
-          phrases : {},
-          cognitive_load : 0
-        }
-      }
-    ) as Progress;
-  }
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-  }
-
-  public get payload():ProgressPayload {
-    this.checkDisposed("Progress.payload");
-    return this.doc.data.payload as ProgressPayload;
-  }
-
-  public setUserRank(value: number): void {
-    this.checkDisposed("Progress.setUserRank");
-    if (this.payload.user_rank !== value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue(['payload', 'user_rank'], value);
-      batch.commit();
-    }
-  }
-
-  public setCognitiveLoad(value: number): void {
-    this.checkDisposed("Progress.setCognitiveLoad");
-    if (this.payload.cognitive_load !== value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue(['payload', 'cognitive_load'], value);
-      batch.commit();
-    }
-  }
-
-  public updatePhraseProgress(phraseId: string, progress: PhraseProgress): void {
-    this.checkDisposed("Progress.updatePhraseProgress");
-    const batch = new BatchOperation(this);
-    batch.setPathValue(['payload', 'phrases', phraseId], progress);
-    batch.commit();
-  }
-
-  public updateMultiplePhrases(updates: Record<string, PhraseProgress>): void {
-    this.checkDisposed("Progress.updateMultiplePhrases");
-    const batch = new BatchOperation(this);
-    for (const [phraseId, progress] of Object.entries(updates)) {
-      batch.setPathValue(['payload', 'phrases', phraseId], progress);
-    }
-    batch.commit();
-  }
-}

package/lib/models/Review.ts

@@ -1,18 +0,0 @@
-import { MultiTime } from "@shaxpir/shaxpir-common";
-
-export type ReviewResult  = 'FAIL' | 'HARD' | 'GOOD' | 'EASY';
-
-export interface ReviewLike {
-  result: ReviewResult;
-  at: MultiTime;
-}
-
-export interface Review extends ReviewLike {
-  text: string;
-  sense_rank: number;
-}
-
-export interface ImpliedReview extends ReviewLike {
-  context: string;
-  weight: number;
-}

package/lib/models/Session.ts

@@ -1,149 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CachingHasher, CompactDateTime, MultiClock, MultiTime, Time } from "@shaxpir/shaxpir-common";
-import { ShareSync, ShareSyncFactory } from '../repo';
-import { Content, ContentBody, ContentId, ContentMeta, ContentRef } from "./Content";
-import { ContentKind } from './ContentKind';
-import { Metric, MetricName } from './Metric';
-import { BatchOperation } from './Operation';
-import { Review } from './Review';
-import { Workspace } from './Workspace';
-import { ArrayView } from './ArrayView';
-
-
-export interface SessionPayload {
-  start:MultiTime;
-  end:MultiTime;
-  tz_offset:number;
-  device_id:ContentId;
-  duration_minutes:number;
-  reviews:Review[];
-}
-
-export interface SessionBody extends ContentBody {
-  meta:ContentMeta;
-  payload:SessionPayload;
-}
-
-export class Session extends Content {
-
-  private _reviewsView:ArrayView<Review>;
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-    this._reviewsView = new ArrayView(this, [ 'payload', 'reviews' ]);
-  }
-
-  public static makeSessionId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind.SESSION) as ContentId;
-  }
-
-  public static makeSessionRef(userId:ContentId, at:MultiTime):ContentRef {
-    let sessionId = Session.makeSessionId(userId);
-    return `${sessionId}_${at.utc_time}` as ContentRef;
-  }
-
-  public static create(
-    userId:ContentId,
-    deviceId:ContentId
-  ):Session {
-
-    let now:MultiTime = MultiClock.now();
-    let sessionId = Session.makeSessionId(userId);
-    let sessionRef = Session.makeSessionRef(userId, now);
-
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : sessionRef,
-          kind : ContentKind.SESSION,
-          id : sessionId,
-          owner : userId,
-          created_at : now,
-          updated_at : now
-        },
-        payload : {
-          start : now,
-          end: now,
-          tz_offset : (new Date()).getTimezoneOffset(),
-          duration_minutes : 0,
-          device_id : deviceId,
-          reviews : []
-        }
-      }
-    ) as Session;
-  }
-
-  public get payload():SessionPayload {
-    this.checkDisposed("Session.payload");
-    return this.doc.data.payload;
-  }
-
-  public touch():void {
-    this.checkDisposed("Session.touch");
-
-    const batch = new BatchOperation(this);
-
-    let nowUtc:CompactDateTime = batch.at.utc_time;
-    let nowLocal:CompactDateTime = batch.at.local_time;
-    let minutes:number = Time.absDiffMinutes(nowUtc, this.start.utc_time);
-
-    batch.setPathValue([ 'payload', 'duration_minutes' ] , minutes);
-    batch.setPathValue([ 'payload', 'end', 'utc_time' ] , nowUtc);
-    batch.setPathValue([ 'payload', 'end', 'local_time' ] , nowLocal);
-
-    batch.commit();
-  }
-
-  public get start():MultiTime {
-    this.checkDisposed("Session.start");
-    return this.payload.start;
-  }
-
-  public get end():MultiTime {
-    this.checkDisposed("Session.end");
-    return this.payload.end;
-  }
-
-  public get tzOffset():number {
-    this.checkDisposed("Session.tzOffset");
-    return this.payload.tz_offset;
-  }
-
-  public get durationMinutes():number {
-    this.checkDisposed("Session.durationMinutes");
-    return this.payload.duration_minutes;
-  }
-
-  public get deviceId():ContentId {
-    this.checkDisposed("Session.deviceId");
-    return this.payload.device_id;
-  }
-
-  public async modelUpdated():Promise<void> {
-    this.checkDisposed("Session.modelUpdated");
-    await super.modelUpdated();
-    const shareSync = this.shareSync;
-    const sessionId = this.id;
-    const userId = this.owner;
-    const date = Time.dateFrom(this.createdAt.local_time);
-    const workspaceId = Workspace.makeWorkspaceId(userId);
-    const workspace = await this.shareSync.acquire(ContentKind.WORKSPACE, workspaceId) as Workspace;
-    const sessionsOnDate:Session[] = await workspace.acquireSessionsFromDate(sessionId, date);
-    workspace.release();
-    let minutesWritingOnDate:number = 0;
-    for (let i = 0, len = sessionsOnDate.length; i < len; i++) {
-      const sessionOnDate = sessionsOnDate[i] as Session;
-      minutesWritingOnDate += sessionOnDate.durationMinutes;
-      sessionOnDate.release();
-    }
-    const minutesWritingMetricId = Metric.makeMetricId(userId, MetricName.MINUTES_WRITING);
-    const minutesWritingMetric = await shareSync.acquire(ContentKind.METRIC, minutesWritingMetricId) as Metric;
-    minutesWritingMetric.setDateAmount(date, minutesWritingOnDate);
-    minutesWritingMetric.release();
-  }
-
-  public addReview(review: Review): void {
-    this.checkDisposed("Session.addReview");
-    this._reviewsView.push(review);
-  }
-}

package/lib/models/Term.ts

@@ -1,202 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CachingHasher, CompactDateTime, MultiClock } from "@shaxpir/shaxpir-common";
-import { BayesianScore } from './BayesianScore';
-import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
-import { BuiltInPhrase, Phrase, PhraseExample } from './Phrase';
-import { ReviewLike } from "./Review";
-import { ContentKind } from './ContentKind';
-import { ShareSync, ShareSyncFactory } from '../repo';
-import { BatchOperation } from './Operation';
-import { ArrayView } from './ArrayView';
-
-export interface TermPayload extends BayesianScore {
-
-  // These fields are always populated. Note that for non-builtin entries, the sense_rank is always zero
-  text: string;
-  sense_rank: number;
-  learn_rank: number;
-  phrase_id: number | null;
-  starred_at: CompactDateTime | null;
-
-  // these phrase fields are omitted for builtin entries (e.g., when phrase_id is not null)
-  // TODO: what about server-provided entries with numeric 'phrase_id' (e.g., if we split the *huge* local
-  // db into a smaller local db with all beginner content, and a bigger cloud db with more advanced content)
-  hanzi_count?: number;
-  pinyin?: string;
-  pinyin_tokenized?: string;
-  transliteration?: string;
-  translation?: string;
-  notes?: string;
-  components?: PhraseExample[];
-  examples?: PhraseExample[];
-  keywords?: string[];
-
-  // if this is a builtin entry, these tags overlay the builtin tags
-  tags: string[];
-
-  reviews: ReviewLike[];
-}
-
-export interface TermBody extends ContentBody {
-  meta:ContentMeta;
-  payload:TermPayload;
-}
-
-export class Term extends Content {
-
-  public static makeTermId(userId:ContentId, text:string, senseRank:number):ContentId {
-    return CachingHasher.makeMd5Base62Hash(`${ContentKind.TERM}-${userId}-${text}-${senseRank}`) as ContentId;
-  }
-
-  private _reviewsView:ArrayView<ReviewLike>;
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-    this._reviewsView = new ArrayView(this, [ 'payload', 'reviews' ]);
-  }
-
-  public static forUserPhrase(
-    userId:ContentId,
-    text:string,
-    senseRank:number,
-    learnRank:number,
-    phraseId?:number
-  ):Term;
-  public static forUserPhrase(
-    userId:ContentId,
-    phrase:Phrase
-  ):Term;
-  public static forUserPhrase(
-    userId:ContentId,
-    textOrPhrase:string | Phrase,
-    senseRank?:number,
-    learnRank?:number,
-    phraseId?:number
-  ):Term {
-    const now = MultiClock.now();
-    
-    // Handle overloaded parameters
-    let phrase: Phrase;
-    if (typeof textOrPhrase === 'string') {
-      // Create a minimal Phrase object from individual parameters
-      phrase = {
-        text: textOrPhrase,
-        sense_rank: senseRank!,
-        learn_rank: learnRank!,
-        hanzi_count: textOrPhrase.length,
-        pinyin: '',
-        pinyin_tokenized: '',
-        transliteration: '',
-        translation: '',
-        notes: '',
-        examples: [],
-        keywords: [],
-        tags: []
-      } as Phrase;
-    } else {
-      phrase = textOrPhrase;
-    }
-    
-    const termId = CachingHasher.makeMd5Base62Hash(`${userId}-${phrase.text}-${phrase.sense_rank}`) as ContentId;
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : termId,
-          kind : ContentKind.TERM,
-          id : termId,
-          owner : userId,
-          created_at : now,
-          updated_at : now
-        },
-        payload : {
-
-          phrase_id : (typeof textOrPhrase === 'string' && phraseId) ? phraseId : null,
-          text : phrase.text,
-          sense_rank : phrase.sense_rank,
-          hanzi_count : phrase.hanzi_count,
-          learn_rank : phrase.learn_rank,
-          pinyin : phrase.pinyin,
-          pinyin_tokenized : phrase.pinyin_tokenized,
-          transliteration : phrase.transliteration,
-          translation : phrase.translation,
-          notes : phrase.notes,
-
-          examples : phrase.examples,
-          keywords : phrase.keywords,
-          tags : phrase.tags,
-
-          starred_at : null,
-
-          alpha: 1,
-          beta: 1,
-          theta: 0.5,
-          reviews: []
-        }
-      }
-    ) as Term;
-  }
-
-  public static forBuiltinPhrase(
-    userId:ContentId,
-    phrase:BuiltInPhrase
-  ):Term {
-    const now = MultiClock.now();
-    const termId = CachingHasher.makeMd5Base62Hash(`${userId}-${phrase.text}-${phrase.sense_rank}`) as ContentId;
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : termId,
-          kind : ContentKind.TERM,
-          id : termId,
-          owner : userId,
-          created_at : now,
-          updated_at : now
-        },
-        payload : {
-
-          text: phrase.text,
-          sense_rank: phrase.sense_rank,
-          learn_rank: phrase.learn_rank,
-          phrase_id : phrase.id,
-          starred_at: null,
-
-          tags : [],
-
-          alpha: 1,
-          beta: 1,
-          theta: 0.5,
-
-          reviews: []
-        }
-      }
-    ) as Term;
-  }
-
-  public get payload():TermPayload {
-    this.checkDisposed("Term.payload");
-    return this.doc.data.payload as TermPayload;
-  }
-
-  public setStarredAt(value: CompactDateTime | null): void {
-    this.checkDisposed("Term.setStarredAt");
-    if (this.payload.starred_at !== value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue(['payload', 'starred_at'], value);
-      batch.commit();
-    }
-  }
-
-  public updateBayesianScore(alpha: number, beta: number, theta: number): void {
-    this.checkDisposed("Term.updateBayesianScore");
-    const batch = new BatchOperation(this);
-    batch.setPathValue(['payload', 'alpha'], alpha);
-    batch.setPathValue(['payload', 'beta'], beta);
-    batch.setPathValue(['payload', 'theta'], theta);
-    batch.commit();
-  }
-
-  public addReview(review: ReviewLike): void {
-    this.checkDisposed("Term.addReview");
-    this._reviewsView.push(review);
-  }
-}

package/lib/models/User.ts

@@ -1,97 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CompactDateTime, MultiClock, MultiTime } from '@shaxpir/shaxpir-common';
-import { ArrayView } from './ArrayView';
-import { Content, ContentId, ContentMeta } from "./Content";
-import { ContentKind } from './ContentKind';
-import { BatchOperation } from './Operation';
-import { ShareSync, ShareSyncFactory } from '../repo';
-
-export interface VerifiablePhone {
-  phone:string;
-  verified_at:CompactDateTime;
-}
-
-export interface VerifiableEmail {
-  email:string;
-  verified_at:CompactDateTime;
-}
-
-export interface UserPayload {
-  emails:VerifiableEmail[];
-  phones:VerifiablePhone[];
-}
-
-export interface UserBody {
-  meta:ContentMeta;
-  payload:UserPayload;
-}
-
-export class User extends Content {
-
-  private _emails:ArrayView<VerifiableEmail>;
-  private _phones:ArrayView<VerifiablePhone>;
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-    this._emails = new ArrayView<VerifiableEmail>(this, [ 'payload', 'emails' ]);
-    this._phones = new ArrayView<VerifiablePhone>(this, [ 'payload', 'phones' ]);
-  }
-
-  public get payload():UserPayload {
-    return this.doc.data.payload as UserPayload;
-  }
-
-  public static create(
-    userId:ContentId,
-    payload:UserPayload,
-    createdAt?:MultiTime
-  ):User {
-    // User creation always happens in UTC time
-    const now = MultiClock.utcNow();
-    // If the createdAt time is not provided, use the current time
-    createdAt ??= now;
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : userId,
-          kind : ContentKind.USER,
-          id : userId,
-          owner : userId,
-          created_at : createdAt,
-          updated_at : now
-        },
-        payload : payload
-      }
-    ) as User;
-  }
-
-  public get emails():ArrayView<VerifiableEmail> {
-    return this._emails;
-  }
-
-  public get phones():ArrayView<VerifiablePhone> {
-    return this._phones;
-  }
-
-  public verifyEmail(email:string, time:CompactDateTime):void {
-    const idx = this._emails.firstIndexWhere(e => e.email === email);
-    if (idx >= 0 && this._emails.get(idx).verified_at !== time) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'emails', idx, 'verified_at' ], time);
-      batch.commit();
-    } else if (idx < 0) {
-      this._emails.push({ email, verified_at: time });
-    }
-  }
-
-  public verifyPhone(phone:string, time:CompactDateTime):void {
-    const idx = this._phones.firstIndexWhere(p => p.phone === phone);
-    if (idx >= 0 && this._phones.get(idx).verified_at !== time) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'phones', idx, 'verified_at' ], time);
-      batch.commit();
-    } else if (idx < 0) {
-      this._phones.push({ phone, verified_at: time });
-    }
-  }
-}