@shaxpir/duiduidui-models 1.0.0 → 1.1.0

package/lib/models/{markup/ChangeModel.ts → ChangeModel.ts}

@@ -1,8 +1,7 @@
-import { Op as DeltaOp } from "@shaxpir/quill-delta";
+import { Tuples } from "@shaxpir/shaxpir-common";
 import * as Changesets from 'json-diff-ts';
 import { Operation } from "json-diff-ts";
-import { Tuples } from "../../util/Tuples";
-import { Model } from "../content/Model";
+import { Model } from "./Model";
 
 export interface ChangeItem {
   type:Operation;
@@ -15,7 +14,7 @@ export interface ModelChange {
   local:boolean;
   model:Model;
   items:ChangeItem[];
-  op:DeltaOp[];
+  op:any[];
 }
 
 export class Changes {

package/lib/models/{content/Content.ts → Content.ts}

@@ -1,16 +1,17 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync } from '../../repo/ShareSync';
-import { Struct } from '../../util/Struct';
-import { BillingPayload } from "./Billing";
+import { CompactDateTime, MultiTime, Struct } from '@shaxpir/shaxpir-common';
+import { ShareSync } from '../repo';
 import { ContentKind } from './ContentKind';
 import { DevicePayload } from './Device';
-import { HanziPayload } from './Hanzi';
+import { MediaPayload } from './Media';
+import { MetricPayload } from './Metric';
 import { Model } from './Model';
-import { PhrasePayload } from './Phrase';
 import { ProfilePayload } from "./Profile";
-import { CompactDateTime, MultiTime } from './Time';
+import { ProgressPayload } from './Progress';
+import { SessionPayload } from './Session';
+import { TermPayload } from './Term';
 import { UserPayload } from './User';
-import { MediaPayload } from './Media';
+import { WorkspacePayload } from './Workspace';
 
 enum ContentIdBrand {}
 enum ContentRefBrand {}
@@ -32,7 +33,6 @@ export interface ContentBody {
 export interface ContentMeta {
   ref:ContentRef;
   kind:ContentKind;
-  is_head:boolean;
   id:ContentId;
   owner:ContentId;
   created_at:MultiTime;
@@ -40,13 +40,15 @@ export interface ContentMeta {
 }
 
 export type ContentPayload =
-  BillingPayload
-| HanziPayload
-| PhrasePayload
-| DevicePayload
+  DevicePayload
 | MediaPayload
+| MetricPayload
 | ProfilePayload
-| UserPayload;
+| ProgressPayload
+| SessionPayload
+| TermPayload
+| UserPayload
+| WorkspacePayload;
 
 export abstract class Content extends Model {
 
@@ -56,11 +58,6 @@ export abstract class Content extends Model {
     super(doc, shouldAcquire, shareSync);
   }
 
-  public get isHead():boolean {
-    this.checkDisposed("Content.isHead");
-    return this.meta.is_head;
-  }
-
   public get meta():ContentMeta {
     this.checkDisposed("Content.meta");
     return this.doc.data.meta as ContentMeta;

package/lib/models/{content/ContentKind.ts → ContentKind.ts}

@@ -1,13 +1,18 @@
 export enum ContentKind {
 
-  // These are all the current Content subclasses
+  // No models yet for these, but they're definitely coming
   BILLING = "billing",
+
+  // These are all the current Content subclasses
   DEVICE = "device",
   METRIC = "metric",
   PROFILE = "profile",
+  PROGRESS = "progress",
   SESSION = "session",
+  TERM = "term",
   USER = "user",
   MEDIA = "media",
+  WORKSPACE = "workspace",
 
   // These are used in the ShareDB system, but for internal bookkeeping, not for Content subclasses.
   MANIFEST = "manifest",

package/lib/models/{content/Device.ts → Device.ts}

@@ -1,17 +1,26 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync, ShareSyncFactory } from '../../repo/ShareSync';
-import { CachingHasher } from '../../util/CachingHasher';
-import { BatchOperation } from '../markup/Operation';
+import { CompactDateTime, MultiClock } from "@shaxpir/shaxpir-common";
+import { ShareSync, ShareSyncFactory } from '../repo';
 import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
 import { ContentKind } from './ContentKind';
-import { CompactDateTime, MultiClock } from './Time';
+import { BatchOperation } from './Operation';
 
 export interface LastSync {
-  at_utc_time:CompactDateTime;
+  at_utc_time:CompactDateTime|null;
+}
+
+export interface TagFilterConfig {
+  any?: string[];
+  all?: string[];
+  none?: string[];
 }
 
 export interface DevicePayload {
   last_sync?:LastSync;
+  chinese_font?: string;
+  raw_search_text?: string;
+  star_filter?: boolean;
+  tag_filter?: TagFilterConfig;
 }
 
 export interface DeviceBody extends ContentBody {
@@ -21,23 +30,15 @@ export interface DeviceBody extends ContentBody {
 
 export class Device extends Content {
 
-  public static makeProfleId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5ContentId(userId + "-" + ContentKind.PROFILE);
-  }
-
   public static create(
     userId:ContentId,
-    deviceId:ContentId,
-    theme:string,
-    typeface:string,
-    typesize:string
+    deviceId:ContentId
   ):Device {
     const now = MultiClock.now();
     return ShareSyncFactory.get().createContent(
       {
         meta : {
           ref : deviceId,
-          is_head : true,
           kind : ContentKind.DEVICE,
           id : deviceId,
           owner : userId,
@@ -62,24 +63,27 @@ export class Device extends Content {
 
   public get lastSyncAtUtcTime():CompactDateTime {
     this.checkDisposed("Device.lastSyncAtUtcTime");
-    this.ensureLastSyncAtUtcTimeExists();
-    return this.payload.last_sync.at_utc_time;
+    return this.payload.last_sync.at_utc_time as CompactDateTime;
   }
   public setLastSyncAtUtcTime(value:CompactDateTime):void {
     this.checkDisposed("Device.setLastSyncAtUtcTime");
-    this.ensureLastSyncAtUtcTimeExists();
     if (this.lastSyncAtUtcTime !== value) {
       const batch = new BatchOperation(this);
       batch.setPathValue([ 'payload', 'last_sync', 'at_utc_time' ] , value);
       batch.commit();
     }
   }
-  private ensureLastSyncAtUtcTimeExists():void {
-    this.checkDisposed("Device.ensureLastSyncAtUtcTimeExists");
-    // If the 'last_sync' field doesn't exist, add it first...
-    if (!this.payload.hasOwnProperty('last_sync')) {
+
+  public get chineseFont():string {
+    this.checkDisposed("Device.chineseFont");
+    return this.payload.chinese_font || 'Huninn';
+  }
+  
+  public setChineseFont(value:string):void {
+    this.checkDisposed("Device.setChineseFont");
+    if (this.chineseFont !== value) {
       const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'last_sync' ] , { at_utc_time : null as CompactDateTime });
+      batch.setPathValue([ 'payload', 'chinese_font' ] , value);
       batch.commit();
     }
   }

package/lib/models/Hanzi.ts

@@ -0,0 +1,16 @@
+export interface Hanzi {
+  text: string;
+  rank: number;
+  components: Array<{
+    text: string;
+    meaning: string;
+    pinyin: string;
+  }>;
+  radical: string;
+  radical_analysis: string;  
+  component_analysis: string;
+}
+
+export interface BuiltInHanzi extends Hanzi {
+  id: number;
+}

package/lib/models/{content/Manifest.ts → Manifest.ts}

@@ -1,11 +1,10 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync, ShareSyncFactory } from '../../repo/ShareSync';
-import { CachingHasher } from '../../util/CachingHasher';
-import { BatchOperation } from "../markup/Operation";
+import { CachingHasher, CompactDateTime, SingleTime, Time } from '@shaxpir/shaxpir-common';
+import { ShareSync, ShareSyncFactory } from '../repo';
 import { Content, ContentId, ContentRef } from "./Content";
 import { ContentKind } from './ContentKind';
 import { Model } from './Model';
-import { CompactDateTime, SingleTime, Time } from './Time';
+import { BatchOperation } from './Operation';
 
 export interface ManifestMeta {
   kind:ContentKind;
@@ -28,8 +27,13 @@ export interface ManifestEntry {
 export interface ManifestPayload {
   device:any;
   media:any;
+  metric:any;
   profile:any;
+  progress:any;
+  session:any;
+  term:any;
   user:any;
+  workspace:any;
 }
 
 export class Manifest extends Model {
@@ -39,7 +43,7 @@ export class Manifest extends Model {
   }
 
   public static makeManifestId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5ContentId(userId + "-" + ContentKind.MANIFEST);
+    return CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind.MANIFEST) as ContentId;
   }
 
   public static create(userId:ContentId):Manifest {
@@ -57,8 +61,13 @@ export class Manifest extends Model {
       payload: {
         device : {},
         media : {},
+        metric : {},
         profile : {},
-        user: {}
+        progress : {},
+        session : {},
+        term : {},
+        user: {},
+        workspace : {}
       }
     });
   }

package/lib/models/{content/Media.ts → Media.ts}

@@ -1,8 +1,8 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync, ShareSyncFactory } from '../../repo/ShareSync';
-import { Content, ContentBody, ContentId, ContentMeta } from './Content';
+import { MultiClock } from '@shaxpir/shaxpir-common';
+import { ShareSync, ShareSyncFactory } from '../repo';
+import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
 import { ContentKind } from './ContentKind';
-import { MultiClock } from './Time';
 
 export interface MediaDimensions {
   width:number;
@@ -44,7 +44,6 @@ export class Media extends Content {
     return ShareSyncFactory.get().createContent({
       meta : {
         ref : mediaId,
-        is_head : true,
         kind : ContentKind.MEDIA,
         id : mediaId,
         owner : userId,

package/lib/models/Metric.ts

@@ -0,0 +1,233 @@
+import { Doc } from '@shaxpir/sharedb/lib/client';
+import { CachingHasher, CompactDate, CompactDateTime, MultiClock, Time } from "@shaxpir/shaxpir-common";
+import dayjs from 'dayjs';
+import utc from 'dayjs/plugin/utc';
+import { ShareSync, ShareSyncFactory } from '../repo';
+import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
+import { ContentKind } from './ContentKind';
+import { BatchOperation } from './Operation';
+
+dayjs.extend(utc);
+
+export enum MetricName {
+  WORD_COUNT = "word_count",
+  MINUTES_WRITING = "minutes_writing"
+}
+
+export interface MetricEntry {
+  date:CompactDate;
+  amount:number;
+}
+
+export interface MetricPayload {
+  metric_name:string;
+  min_date:CompactDate;
+  max_date:CompactDate;
+  entries:{[key:string]:number};
+}
+
+export interface MetricBody extends ContentBody {
+  meta:ContentMeta;
+  payload:MetricPayload;
+}
+
+export class Metric extends Content {
+
+  public static makeMetricId(userId:ContentId, metricName:MetricName):ContentId {
+    return CachingHasher.makeMd5Base62Hash(userId + "-metric-" + metricName) as ContentId;
+  }
+
+  public static create(
+    userId:ContentId,
+    metricName:MetricName,
+    entries:{[key:string]:number}
+  ):Metric {
+
+    const metricId = Metric.makeMetricId(userId, metricName);
+
+    // Find the min and max dates
+    let minDate:CompactDate = null as CompactDateTime;
+    let maxDate:CompactDate = null as CompactDateTime;
+    for (let d of Object.keys(entries)) {
+      const date:CompactDate = d as CompactDate;
+      if (minDate === null || Time.compareDate(date, minDate) < 0) {
+        minDate = date;
+      }
+      if (maxDate === null || Time.compareDate(date, maxDate) > 0) {
+        maxDate = date;
+      }
+    }
+    const now = MultiClock.now();
+    return ShareSyncFactory.get().createContent(
+      {
+        meta : {
+          ref : metricId,
+          kind : ContentKind.METRIC,
+          id : metricId,
+          owner : userId,
+          created_at : now,
+          updated_at : now
+        },
+        payload : {
+          metric_name : metricName,
+          min_date : minDate,
+          max_date : maxDate,
+          entries : entries
+        }
+      }
+    ) as Metric;
+  }
+
+  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
+    super(doc, shouldAcquire, shareSync);
+  }
+
+  public get payload():MetricPayload {
+    this.checkDisposed("Metric.payload");
+    return this.doc.data.payload as MetricPayload;
+  }
+
+  public get metricName():string {
+    this.checkDisposed("Metric.name");
+    return this.payload.metric_name;
+  }
+
+  public get minDate():CompactDate {
+    this.checkDisposed("Metric.minDate");
+    return this.payload.min_date;
+  }
+
+  public get maxDate():CompactDate {
+    this.checkDisposed("Metric.maxDate");
+    return this.payload.max_date;
+  }
+
+  public get length():number {
+    this.checkDisposed("Metric.length");
+    const minMoment:any = dayjs.utc(this.minDate, Time.DATE_FORMAT);
+    const maxMoment:any = dayjs.utc(this.maxDate, Time.DATE_FORMAT);
+    return Math.abs(maxMoment.diff(minMoment, "days")) + 1;
+  }
+
+  public get(index:number):MetricEntry {
+    this.checkDisposed("Metric.get");
+    if (index === 0) {
+      return {
+        date: this.minDate,
+        amount: this.forDate(this.minDate)
+      };
+    } else {
+      const minMoment:any = dayjs.utc(this.minDate, Time.DATE_FORMAT);
+      const offsetDate:CompactDate = minMoment.add(index, 'days').format(Time.DATE_FORMAT) as CompactDate;
+      return {
+        date: offsetDate,
+        amount: this.forDate(offsetDate)
+      };
+    }
+  }
+
+  public sumBetween(minDate:CompactDate, maxDate:CompactDate):number {
+    this.checkDisposed("Metric.sumBetween");
+    let sum:number = 0;
+    const dates:CompactDate[] = Time.datesBetween(minDate, maxDate);
+    for (let i = 0, len = dates.length; i < len; i++) {
+      const date:CompactDate = dates[i];
+      sum += this.forDate(date);
+    }
+    return sum;
+  }
+
+  public forDate(date:CompactDate):number {
+    this.checkDisposed("Metric.forDate");
+    const map:any = this.payload.entries;
+    if (map.hasOwnProperty(date)) {
+      return map[date as string];
+    }
+    return 0.0;
+  }
+
+  public nonZeroDayCount():number {
+    this.checkDisposed("Metric.nonZeroDayCount");
+    let count:number = 0;
+    const map:any = this.payload.entries;
+    for (let date of Object.keys(map)) {
+      if (map[date] !== 0.0) {
+        count++;
+      }
+    }
+    return count;
+  }
+
+  public setDateAmount(date:CompactDate, amount:number):void {
+    this.checkDisposed("Metric.setDateAmount");
+
+    const prevMinDate = this.payload.min_date;
+    const prevMaxDate = this.payload.max_date;
+
+    const batch = new BatchOperation(this);
+    batch.setPathValue([ 'payload', 'entries', date ] , amount);
+
+    if (prevMinDate === null || Time.compareDate(date, prevMinDate) < 0) {
+      batch.setPathValue([ 'payload', 'min_date' ] , date);
+    }
+    if (prevMaxDate === null || Time.compareDate(date, prevMaxDate) > 0) {
+      batch.setPathValue([ 'payload', 'max_date' ] , date);
+    }
+
+    batch.commit();
+  }
+
+  public incrementDateAmounts(dateAmounts:{[key:string]:number}):void {
+    this.checkDisposed("Metric.incrementDateAmounts");
+
+    const prevMinDate = this.payload.min_date;
+    const prevMaxDate = this.payload.max_date;
+
+    let minDate = prevMinDate;
+    let maxDate = prevMaxDate;
+
+    const batch = new BatchOperation(this);
+
+    const dates = Object.keys(dateAmounts);
+    for (let i = 0; i < dates.length; i++) {
+      const date:CompactDate = dates[i] as CompactDate;
+
+      const prevAmount:number = this.forDate(date);
+      const newAmount:number = dateAmounts[date];
+
+      batch.setPathValue([ 'payload', 'entries', date ] , prevAmount + newAmount);
+
+      if (minDate === null || Time.compareDate(date, minDate) < 0) {
+        minDate = date;
+      }
+      if (maxDate === null || Time.compareDate(date, maxDate) > 0) {
+        maxDate = date;
+      }
+    }
+
+    if (minDate != prevMinDate) {
+      batch.setPathValue([ 'payload', 'min_date' ] , minDate);
+    }
+    if (maxDate != prevMaxDate) {
+      batch.setPathValue([ 'payload', 'max_date' ] , maxDate);
+    }
+
+    batch.commit();
+  }
+
+  public static forEachEntry(
+    body:MetricBody,
+    callback:(entry:MetricEntry) => void
+  ):void {
+    const dates = Object.keys(body.payload.entries);
+    for (let i = 0; i < dates.length; i++) {
+      const date = dates[i] as CompactDate;
+      const amount = body.payload.entries[date] as number;
+      callback({
+        date : date,
+        amount : amount
+      });
+    }
+  }
+
+}

package/lib/models/{content/Model.ts → Model.ts}

@@ -1,13 +1,11 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync } from '../../repo/ShareSync';
-import { Struct } from '../../util/Struct';
-import { Dispatch, DispatchTopic } from '../../util/Dispatch';
-import { ChangeModel } from '../markup/ChangeModel';
-import { ContentId, ContentMeta, ContentRef } from './Content';
+import { CompactDateTime, Dispatch, DispatchTopic, Struct } from '@shaxpir/shaxpir-common';
+import { ShareSync } from '../repo';
+import { ContentId, ContentMeta, ContentRef } from "./Content";
 import { ContentKind } from './ContentKind';
 import { ManifestBody } from './Manifest';
 import { PermissionType } from './Permissions';
-import { CompactDateTime } from './Time';
+import { ChangeModel } from './ChangeModel';
 
 export abstract class Model {
 

package/lib/models/{markup/Operation.ts → Operation.ts}

@@ -1,15 +1,12 @@
-import { Op as DeltaOp } from "@shaxpir/quill-delta";
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSyncFactory } from '../../repo/ShareSync';
-import { Struct } from '../../util/Struct';
-import { Content } from '../content/Content';
-import { Model } from '../content/Model';
-import { MultiClock, MultiTime } from '../content/Time';
-import { TextEditOps } from './TextEditOps';
+import { MultiClock, MultiTime, Struct } from '@shaxpir/shaxpir-common';
+import { TextEditOps } from '../repo/TextEditOps';
 
-import * as Json1 from '../../repo/PermissiveJson1';
+import * as Json1 from '../repo/PermissiveJson1';
+import { Model } from './Model';
+import { ShareSyncFactory } from '../repo';
+import { Content } from './Content';
 
-const RichText = require('@shaxpir/rich-text');
 const UnicodeText = require('ot-text-unicode');
 
 export type JsonPathElement = string | number;
@@ -184,13 +181,6 @@ export class BatchOperation {
     }
   }
 
-  public applyRichText(
-    path:JsonPath,
-    deltaOps:DeltaOp[]
-  ):void {
-    this.ops.push(Json1.editOp(path, RichText.type, deltaOps));
-  }
-
   public commit():void {
     const batch = this;
     if (batch.ops.length > 0) {

package/lib/models/{content/Permissions.ts → Permissions.ts}

@@ -1,5 +1,3 @@
-import { ContentId } from "./Content";
-
 export enum PermissionType {
   READ,
   WRITE

package/lib/models/Phrase.ts

@@ -0,0 +1,53 @@
+import { CompactDateTime } from "@shaxpir/shaxpir-common";
+import { ContentId } from "./Content";
+import { ReviewLike } from "./Review";
+
+export interface PhraseExample {
+  id: number;
+  text: string;
+  pinyin: string;
+  translation: string;
+  learn_rank: number;
+  sense_rank: number;
+}
+
+export interface Phrase {
+  text: string;
+  hanzi_count: number;
+  sense_rank: number;
+  learn_rank: number;
+  pinyin: string;
+  pinyin_tokenized: string;
+  transliteration: string;
+  translation: string;
+  notes: string;
+  examples?: PhraseExample[];
+  components?: PhraseExample[];
+  keywords?: string[];
+  tags?: string[];
+}
+
+export interface BuiltInPhrase extends Phrase {
+  id: number;
+}
+
+export interface AnnotatedPhrase extends Phrase {
+
+  // Always populated. If this is a builtin entry, it will be `phrase-${phrase_id}`.
+  // If this is a user-specific entry, it will be `term-${term_id}`.
+  id: string;
+
+  // if this is populated, the Phrase comes from the built-in database
+  phrase_id?: number;
+
+  // if this is populated, then there is a user-specific Term model associated with this Phrase
+  content_id?: ContentId;
+
+  // All these fields come from the Term model, if it exists. If it doesn't exist, then these fields
+  // have default values (null for starred_at, numbers are zero, arrays are empty, etc.)
+  starred_at: CompactDateTime | null; 
+  alpha: number;
+  beta: number;
+  proficiency: number;
+  reviews: ReviewLike[];
+}

package/lib/models/{content/Profile.ts → Profile.ts}

@@ -1,11 +1,10 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync, ShareSyncFactory } from '../../repo/ShareSync';
-import { CachingHasher } from '../../util/CachingHasher';
-import { BatchOperation } from '../markup/Operation';
+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 { MultiClock } from './Time';
+import { BatchOperation } from './Operation';
 
 export interface ProfilePayload {
   username:string;
@@ -22,7 +21,7 @@ export interface ProfileBody extends ContentBody {
 export class Profile extends Content {
 
   public static makeProfileId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5ContentId(userId + "-" + ContentKind.PROFILE);
+    return CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind.PROFILE) as ContentId;
   }
 
   public static create(userId:ContentId):Profile {
@@ -32,7 +31,6 @@ export class Profile extends Content {
       {
         meta : {
           ref : profileId,
-          is_head : true,
           kind : ContentKind.PROFILE,
           id : profileId,
           owner : userId,