@shaxpir/duiduidui-models 1.3.2 → 1.3.4

package/lib/models/Device.ts

@@ -1,90 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CompactDateTime, MultiClock } from "@shaxpir/shaxpir-common";
-import { ShareSync, ShareSyncFactory } from '../repo';
-import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
-import { ContentKind } from './ContentKind';
-import { BatchOperation } from './Operation';
-
-export interface LastSync {
-  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 {
-  meta:ContentMeta;
-  payload:DevicePayload;
-}
-
-export class Device extends Content {
-
-  public static create(
-    userId:ContentId,
-    deviceId:ContentId
-  ):Device {
-    const now = MultiClock.now();
-    return ShareSyncFactory.get().createContent(
-      {
-        meta : {
-          ref : deviceId,
-          kind : ContentKind.DEVICE,
-          id : deviceId,
-          owner : userId,
-          created_at : now,
-          updated_at : now
-        },
-        payload : {
-          last_sync : { at_utc_time : null as CompactDateTime }
-        }
-      }
-    ) as Device;
-  }
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-  }
-
-  public get payload():DevicePayload {
-    this.checkDisposed("Device.payload");
-    return this.doc.data.payload as DevicePayload;
-  }
-
-  public get lastSyncAtUtcTime():CompactDateTime {
-    this.checkDisposed("Device.lastSyncAtUtcTime");
-    return this.payload.last_sync.at_utc_time as CompactDateTime;
-  }
-  public setLastSyncAtUtcTime(value:CompactDateTime):void {
-    this.checkDisposed("Device.setLastSyncAtUtcTime");
-    if (this.lastSyncAtUtcTime !== value) {
-      const batch = new BatchOperation(this);
-      batch.setPathValue([ 'payload', 'last_sync', 'at_utc_time' ] , value);
-      batch.commit();
-    }
-  }
-
-  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', 'chinese_font' ] , value);
-      batch.commit();
-    }
-  }
-}

package/lib/models/GeoLocation.ts

@@ -1,4 +0,0 @@
-export interface GeoLocation {
-  lat:number;
-  lon:number;
-}

package/lib/models/Hanzi.ts

@@ -1,16 +0,0 @@
-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/Manifest.ts

@@ -1,171 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-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 { BatchOperation } from './Operation';
-
-export interface ManifestMeta {
-  kind:ContentKind;
-  ref:ContentRef;
-  updated_at:SingleTime;
-  owner:ContentId;
-}
-
-export interface ManifestBody {
-  meta:ManifestMeta;
-  payload:ManifestPayload;
-}
-
-export interface ManifestEntry {
-  kind:ContentKind;
-  ref:ContentRef;
-  at_utc_time:CompactDateTime;
-}
-
-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 {
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-  }
-
-  public static makeManifestId(userId:ContentId):ContentId {
-    return CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind.MANIFEST) as ContentId;
-  }
-
-  public static create(userId:ContentId):Manifest {
-    const now:CompactDateTime = Time.utc();
-    const manifestId = Manifest.makeManifestId(userId);
-    return ShareSyncFactory.get().createManifest({
-      meta : {
-        kind : ContentKind.MANIFEST,
-        ref : manifestId,
-        updated_at : {
-          utc_time : now
-        },
-        owner : userId
-      },
-      payload: {
-        device : {},
-        media : {},
-        metric : {},
-        profile : {},
-        progress : {},
-        session : {},
-        term : {},
-        user: {},
-        workspace : {}
-      }
-    });
-  }
-
-  public get meta():ManifestMeta {
-    this.checkDisposed("Manifest.meta");
-    return this.doc.data.meta as ManifestMeta;
-  }
-
-  public get owner():ContentId {
-    this.checkDisposed("Manifest.userId");
-    return this.doc.data.meta.owner as ContentId;
-  }
-
-  public canUserView(userId:ContentId):boolean {
-    this.checkDisposed("Manifest.canUserView");
-    return this.doc.data.meta.owner === userId;
-  }
-
-  public doesContentExist(kind:ContentKind, ref:ContentRef):boolean {
-    this.checkDisposed("Manifest.doesContentExist");
-    return this.doc.data &&
-      this.doc.data.payload &&
-      this.doc.data.payload[kind] &&
-      this.doc.data.payload[kind][ref];
-  }
-
-  public getUtcTimeOf(kind:ContentKind, ref:ContentRef):CompactDateTime {
-    this.checkDisposed("Manifest.getTimestampOf");
-    if (this.doesContentExist(kind, ref)) {
-      return this.doc.data.payload[kind][ref] as CompactDateTime;
-    }
-    return null as CompactDateTime;
-  }
-
-  public getAllEntries():ManifestEntry[] {
-    return this.getAllEntriesWhere(() => true);
-  }
-
-  public getAllEntriesWhere(
-    predicate?:(entry:ManifestEntry) => boolean
-  ):ManifestEntry[] {
-    const entries = [] as ManifestEntry[];
-    if (this.exists() && this.doc.data.payload) {
-      Manifest.forEachEntry(
-        this.doc.data as ManifestBody,
-        (entry:ManifestEntry) => {
-          if (!predicate || predicate(entry)) {
-            entries.push(entry);
-          }
-        }
-      );
-    }
-    return entries;
-  }
-
-  public update(content:Content):void {
-    this.checkDisposed("Manifest.update");
-    content.acquire().then(() => {
-
-      const kind:ContentKind = content.kind;
-      const contentRef:ContentId = content.ref;
-
-      const timestamp:CompactDateTime = content.updatedAt.utc_time;
-      const batch = new BatchOperation(this, content.meta.updated_at);
-
-      // Update the embedded timestamp of this content item
-      batch.setPathValue([ 'payload', kind, contentRef ], timestamp);
-
-      batch.commit();
-      content.release();
-    });
-  }
-
-  public static forEachEntry(
-    body:ManifestBody,
-    callback:(entry:ManifestEntry) => void
-  ):void {
-    const kinds = Object.keys(body.payload);
-    for (let i = 0; i < kinds.length; i++) {
-      const kind = kinds[i] as ContentKind;
-      const manifestPayload = (body.payload as any)[kind];
-      const refs = Object.keys(manifestPayload);
-      for (let j = 0; j < refs.length; j++) {
-        const ref = refs[j] as ContentRef;
-        const timestamp = manifestPayload[ref] as CompactDateTime;
-        if (ref && timestamp) {
-          const entry = {
-            kind : kind,
-            ref : ref,
-            at_utc_time : timestamp
-          };
-          callback(entry);
-        } else {
-          console.error(`manifest with missing ref or timestamp: ${JSON.stringify(body)}`);
-        }
-      }
-    }
-  }
-
-}

package/lib/models/Media.ts

@@ -1,125 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { MultiClock } from '@shaxpir/shaxpir-common';
-import { ShareSync, ShareSyncFactory } from '../repo';
-import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
-import { ContentKind } from './ContentKind';
-
-export interface MediaDimensions {
-  width:number;
-  height:number;
-}
-
-export interface MediaCropping extends MediaDimensions {
-  offset_top:number;
-  offset_left:number;
-}
-
-export interface MediaPayload extends MediaDimensions {
-  extension:string;
-  bytes:number;
-}
-
-export interface MediaBody extends ContentBody {
-  meta:ContentMeta;
-  payload:MediaPayload;
-}
-
-export class Media extends Content {
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-  }
-
-  public get payload():MediaPayload {
-    this.checkDisposed("Media.payload");
-    return this.doc.data.payload as MediaPayload;
-  }
-
-  public static create(
-    userId:ContentId,
-    mediaId:ContentId,
-    payload:MediaPayload
-  ):Media {
-    const now = MultiClock.now();
-    return ShareSyncFactory.get().createContent({
-      meta : {
-        ref : mediaId,
-        kind : ContentKind.MEDIA,
-        id : mediaId,
-        owner : userId,
-        created_at : now,
-        updated_at : now
-      },
-      payload : payload
-    }) as Media;
-  }
-
-  get bytes():number {
-    this.checkDisposed("Media.bytes");
-    return this.payload.bytes;
-  }
-
-  get width():number {
-    this.checkDisposed("Media.width");
-    return this.payload.width;
-  }
-
-  get height():number {
-    this.checkDisposed("Media.height");
-    return this.payload.height;
-  }
-
-  get extension():string {
-    this.checkDisposed("Media.extension");
-    return this.payload.extension;
-  }
-
-  public get mediaType():string {
-    this.checkDisposed("Media.mediaType");
-    const extension:string = this.extension;
-    if (extension === "jpg" || extension === "jpeg") {
-      return "image/jpeg";
-    } else if (extension === "png") {
-      return "image/png";
-    } else if (extension === "gif") {
-      return "image/gif";
-    } else if (extension === "svg") {
-      return "image/svg+xml";
-    } else if (extension === "bmp") {
-      return "image/bmp";
-    }
-    return "image/" + extension;
-  }
-
-  public scaleToFit(boxSize:number, cropping:MediaCropping):MediaCropping {
-    this.checkDisposed("Media.scaleToFit");
-    const zoom = boxSize / cropping.width;
-    const scaledWidth = Math.floor(this.width * zoom);
-    const scaledHeight = Math.floor(this.height * zoom);
-    const offsetLeft = -Math.floor(cropping.offset_left * zoom);
-    const offsetTop = -Math.floor(cropping.offset_top * zoom);
-    return {
-      "offset_top" : offsetTop,
-      "offset_left" : offsetLeft,
-      "width" : scaledWidth,
-      "height" : scaledHeight
-    };
-  }
-
-  public static makeDefaultCropping(media:Media):MediaCropping {
-    const width = media.width;
-    const height = media.height;
-    const isLandscapeOrSquare:boolean = width >= height;
-    const isPortraitOrSquare:boolean = height >= width;
-    const croppingOffsetTop:number = isLandscapeOrSquare ? 0 : Math.floor((height - width) / 2);
-    const croppingOffsetLeft:number = isPortraitOrSquare ? 0 : Math.floor((width - height) / 2);
-    const croppingWidth:number = isLandscapeOrSquare ? height : width;
-    const croppingHeight:number = isPortraitOrSquare ? width : height;
-    return {
-      offset_top : croppingOffsetTop,
-      offset_left : croppingOffsetLeft,
-      width : croppingWidth,
-      height : croppingHeight
-    };
-  }
-}

package/lib/models/Metric.ts

@@ -1,233 +0,0 @@
-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
-      });
-    }
-  }
-
-}