@shaxpir/duiduidui-models 1.3.2 → 1.3.4

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import '../decs.d.ts';
 export * from './models';
 export * from './repo';
 export * from './util';

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /// <reference path="../decs.d.ts" />
+require("../decs.d.ts");
 __exportStar(require("./models"), exports);
 __exportStar(require("./repo"), exports);
 __exportStar(require("./util"), exports);

package/dist/models/Model.d.ts

@@ -12,6 +12,8 @@ export declare abstract class Model {
     private _isForbidden;
     private _shouldPerformModelChangeAnalysis;
     private _dataBeforeOpBatch;
+    private _hasEventListeners;
+    private _setupEventListeners;
     private _clearEventListeners;
     protected shareSync: ShareSync;
     private _subscribingPromise;

package/dist/models/Model.js

@@ -8,6 +8,7 @@ const ChangeModel_1 = require("./ChangeModel");
 class Model {
     constructor(doc, shouldAcquire, shareSync) {
         this._dataBeforeOpBatch = null;
+        this._setupEventListeners = null;
         this._clearEventListeners = null;
         this._subscribingPromise = null;
         this._acquireCount = 0;
@@ -16,6 +17,7 @@ class Model {
         model.shareSync = shareSync;
         model._isDisposed = false;
         model._isForbidden = false;
+        model._hasEventListeners = false;
         // When a model is newly created, or retrieved via a "fetch query", treat that as an implicit
         // call to "acquire", since the SharedDB doc object will eventually need to be disposed.
         if (shouldAcquire) {
@@ -46,12 +48,18 @@ class Model {
                 shaxpir_common_1.Dispatch.publish(Model.CHANGED, change);
             }
         };
-        model.doc.on('before op batch', onBeforeOpBatch);
-        model.doc.on('op batch', onOpBatch);
+        this._setupEventListeners = function () {
+            if (model.doc && model.doc.on) {
+                model.doc.on('before op batch', onBeforeOpBatch);
+                model.doc.on('op batch', onOpBatch);
+                model._hasEventListeners = true;
+            }
+        };
         this._clearEventListeners = function () {
             if (model.doc && model.doc.off) {
                 model.doc.off('before op batch', onBeforeOpBatch);
                 model.doc.off('op batch', onOpBatch);
+                model._hasEventListeners = false;
             }
         };
     }
@@ -78,6 +86,9 @@ class Model {
     }
     async acquire(minVersion) {
         this._acquireCount++;
+        if (!this._hasEventListeners) {
+            this._setupEventListeners();
+        }
         if (minVersion) {
             this.log(`ACQUIRE: (${this.compoundKey}) at minVersion '${minVersion}'; acquireCount = ${this.acquireCount}`);
             return this.ensureRecentData(minVersion);

package/dist/repo/ShareSync.js

@@ -45,6 +45,7 @@ const Content_1 = require("../models/Content");
 const ContentKind_1 = require("../models/ContentKind");
 const Device_1 = require("../models/Device");
 const Manifest_1 = require("../models/Manifest");
+const Session_1 = require("../models/Session");
 const User_1 = require("../models/User");
 // Register the ShareDB types
 const Json1 = __importStar(require("./PermissiveJson1"));
@@ -335,18 +336,36 @@ class ShareSync {
     }
     wrap(kind, doc, shouldAcquire) {
         const shareSync = this;
-        if (kind === ContentKind_1.ContentKind.MANIFEST) {
+        if (kind === ContentKind_1.ContentKind.DEVICE) {
+            return new Device_1.Device(doc, shouldAcquire, shareSync);
+        }
+        else if (kind === ContentKind_1.ContentKind.MANIFEST) {
             return new Manifest_1.Manifest(doc, shouldAcquire, shareSync);
         }
-        else if (kind === ContentKind_1.ContentKind.USER) {
-            return new User_1.User(doc, shouldAcquire, shareSync);
+        else if (kind === ContentKind_1.ContentKind.METRIC) {
+            return new models_1.Metric(doc, shouldAcquire, shareSync);
         }
-        else if (kind === ContentKind_1.ContentKind.DEVICE) {
-            return new Device_1.Device(doc, shouldAcquire, shareSync);
+        else if (kind === ContentKind_1.ContentKind.MEDIA) {
+            return new models_1.Media(doc, shouldAcquire, shareSync);
         }
         else if (kind === ContentKind_1.ContentKind.PROFILE) {
             return new models_1.Profile(doc, shouldAcquire, shareSync);
         }
+        else if (kind === ContentKind_1.ContentKind.PROGRESS) {
+            return new models_1.Progress(doc, shouldAcquire, shareSync);
+        }
+        else if (kind === ContentKind_1.ContentKind.SESSION) {
+            return new Session_1.Session(doc, shouldAcquire, shareSync);
+        }
+        else if (kind === ContentKind_1.ContentKind.TERM) {
+            return new models_1.Term(doc, shouldAcquire, shareSync);
+        }
+        else if (kind === ContentKind_1.ContentKind.USER) {
+            return new User_1.User(doc, shouldAcquire, shareSync);
+        }
+        else if (kind === ContentKind_1.ContentKind.WORKSPACE) {
+            return new models_1.Workspace(doc, shouldAcquire, shareSync);
+        }
         throw new Error(`can't wrap content ${kind}/${doc.id}`);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shaxpir/duiduidui-models",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/shaxpir/duiduidui-models"
@@ -12,6 +12,10 @@
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "decs.d.ts"
+  ],
   "dependencies": {
     "@shaxpir/sharedb": "^5.3.0",
     "@shaxpir/shaxpir-common": "1.3.0",

package/lib/index.ts

@@ -1,7 +0,0 @@
-// created from 'create-ts-index'
-
-/// <reference path="../decs.d.ts" />
-
-export * from './models';
-export * from './repo';
-export * from './util';

package/lib/models/ArrayView.ts

@@ -1,203 +0,0 @@
-import { JsonPath, Struct } from '@shaxpir/shaxpir-common';
-import { Content } from "./Content";
-import { BatchOperation, JsonPathSelect } from './Operation';
-
-export class ArrayView<T> {
-
-    protected content:Content;
-    protected path:JsonPath;
-
-    constructor (content:Content, path:JsonPath) {
-      this.content = content;
-      this.path = path;
-    }
-
-    private get root():T[] {
-      this.content.checkDisposed("ArrayView.root");
-      return JsonPathSelect.getValueAtPath(this.content.doc, this.path);
-    }
-
-    public get length():number {
-      this.content.checkDisposed("ArrayView.length");
-      return this.root.length;
-    }
-
-    public get values():T[] {
-      this.content.checkDisposed("ArrayView.values");
-      return Struct.clone(this.root);
-    }
-
-    public get(idx:number):T {
-      this.content.checkDisposed("ArrayView.get");
-      return Struct.clone(this.root[idx]);
-    }
-
-    public indexOf(value:any):number {
-      this.content.checkDisposed("ArrayView.indexOf");
-      const array:T[] = JsonPathSelect.getValueAtPath(this.content.doc, this.path);
-      for (let i:number = 0; i < array.length; i++) {
-        if (array[i] == value) {
-          return i;
-        }
-      }
-      return -1;
-    }
-
-    public includes(value:any):boolean {
-      this.content.checkDisposed("ArrayView.includes");
-      const array:T[] = JsonPathSelect.getValueAtPath(this.content.doc, this.path);
-      for (let i:number = 0; i < array.length; i++) {
-        if (array[i] == value) {
-          return true;
-        }
-      }
-      return false;
-    }
-
-    public firstIndexWhere(
-      predicate:(value:T) => boolean
-    ):number {
-      this.content.checkDisposed("ArrayView.firstIndexWhere");
-      const array:T[] = JsonPathSelect.getValueAtPath(this.content.doc, this.path);
-      for (let i:number = 0; i < array.length; i++) {
-        if (predicate(array[i])) {
-          return i;
-        }
-      }
-      return -1;
-    }
-
-    public removeFirstWhere(
-      predicate:(value:T) => boolean
-    ):void {
-      this.content.checkDisposed("ArrayView.removeFirstWhere");
-      const index:number = this.firstIndexWhere(predicate);
-      this.removeAt(index);
-    }
-
-    public removeAllWhere(
-      predicate:(value:T) => boolean
-    ):void {
-      this.content.checkDisposed("ArrayView.removeAllWhere");
-      let foundMatch = false;
-      const batch = new BatchOperation(this.content);
-      const array:T[] = JsonPathSelect.getValueAtPath(this.content.doc, this.path);
-      for (let i:number = 0; i < array.length; i++) {
-        if (predicate(array[i])) {
-          const pathToElement:JsonPath = Struct.clone(this.path);
-          pathToElement.push(i);
-          batch.removeValueAtPath(pathToElement);
-          foundMatch = true;
-        }
-      }
-      if (foundMatch) {
-        batch.commit();
-      }
-    }
-
-    public forEach(
-      callback:(idx:number, value:T) => void
-    ):void {
-      this.content.checkDisposed("ArrayView.forEach");
-      const array:T[] = JsonPathSelect.getValueAtPath(this.content.doc, this.path);
-      for (let i:number = 0; i < array.length; i++) {
-        callback(i, array[i]);
-      }
-    }
-
-    public unshift(value:T):void {
-      this.content.checkDisposed("ArrayView.unshift");
-      const batch = new BatchOperation(this.content);
-      batch.unshiftIntoArray(this.path, value);
-      batch.commit();
-    }
-
-    public push(value:T):void {
-      this.content.checkDisposed("ArrayView.push");
-      const batch = new BatchOperation(this.content);
-      batch.pushIntoArray(this.path, value);
-      batch.commit();
-    }
-
-    public insert(idx:number, value:T):void {
-      this.content.checkDisposed("ArrayView.insert");
-      if (idx == this.length) {
-        this.push(value);
-      } else {
-        const batch = new BatchOperation(this.content);
-        batch.insertIntoArray(this.path, idx, value);
-        batch.commit();
-      }
-    }
-
-    public remove(value:T):void {
-      this.content.checkDisposed("ArrayView.remove");
-      const index:number = this.indexOf(value);
-      if (index >= 0) {
-        this.removeAt(index);
-      }
-    }
-
-    public removeAt(index:number):void {
-      this.content.checkDisposed("ArrayView.removeAt");
-      const pathToElement:JsonPath = Struct.clone(this.path);
-      pathToElement.push(index);
-      const batch = new BatchOperation(this.content);
-      batch.removeValueAtPath(pathToElement);
-      batch.commit();
-    }
-
-    public move(originIndex:number, destinationIndex:number):void {
-      this.content.checkDisposed("ArrayView.move");
-      if (originIndex != destinationIndex) {
-        const originPath:JsonPath = Struct.clone(this.path);
-        const destinationPath:JsonPath = Struct.clone(this.path);
-        originPath.push(originIndex);
-        destinationPath.push(destinationIndex);
-        const batch = new BatchOperation(this.content);
-        batch.move(originPath, destinationPath);
-        batch.commit();
-      }
-    }
-
-    public removeObjectPropertyAtIndex(index:number, fieldName:string):void {
-      this.content.checkDisposed("ArrayView.setObjectValueAtIndex");
-      const pathToElement:JsonPath = Struct.clone(this.path);
-      pathToElement.push(index);
-      const element:any = JsonPathSelect.getValueAtPath(this.content.doc, pathToElement);
-      if (element.hasOwnProperty(fieldName)) {
-        const pathToProperty:JsonPath = Struct.clone(this.path);
-        pathToProperty.push(fieldName);
-        const batch = new BatchOperation(this.content);
-        batch.removeValueAtPath(pathToProperty)
-        batch.commit();
-      }
-    }
-
-    public setObjectValueAtIndex(index:number, fieldName:string, newValue:any):void {
-      this.content.checkDisposed("ArrayView.setObjectValueAtIndex");
-      const pathToElement:JsonPath = Struct.clone(this.path);
-      pathToElement.push(index);
-      pathToElement.push(fieldName);
-      const prevValue:any = JsonPathSelect.getValueAtPath(this.content.doc, pathToElement);
-      if (!Struct.equals(prevValue, newValue)) {
-        const batch = new BatchOperation(this.content);
-        batch.setPathValue(pathToElement, newValue);
-        batch.commit();
-      }
-    }
-
-    public editObjectTextValueAtIndex(index:number, fieldName:string, newValue:string):void {
-      this.content.checkDisposed("ArrayView.editObjectTextValueAtIndex");
-      const pathToElement:JsonPath = Struct.clone(this.path);
-      pathToElement.push(index);
-      pathToElement.push(fieldName);
-      const prevValue:any = JsonPathSelect.getValueAtPath(this.content.doc, pathToElement);
-      if (!Struct.equals(prevValue, newValue)) {
-        const batch = new BatchOperation(this.content);
-        batch.editPathText(pathToElement, newValue);
-        batch.commit();
-      }
-    }
-
-  }

package/lib/models/BayesianScore.ts

@@ -1,32 +0,0 @@
-import { Struct } from "@shaxpir/shaxpir-common";
-import { ReviewResult } from "./Review";
-
-export interface BayesianScore {
-  alpha:number;
-  beta:number;
-  theta:number;
-}
-
-export class BayesianScoreModel {
-  public static apply(
-    prevScore:BayesianScore,
-    result:ReviewResult,
-    weight:number
-  ):BayesianScore {
-    if (isNaN(weight) || !isFinite(weight) || weight < 0 || weight > 1) {
-      throw new Error(`illegal weight value: ${weight}`);
-    }
-    const nextScore = Struct.clone(prevScore) as BayesianScore;
-    if (result == 'EASY') {
-      nextScore.alpha += (weight * 1.0);
-    } else if (result == 'GOOD') {
-      nextScore.alpha += (weight * 0.7);
-    } else if (result == 'HARD') {
-      nextScore.beta += (weight * 0.3);
-    } else if (result == 'FAIL') {
-      nextScore.beta += (weight * 1.0);
-    }
-    nextScore.theta = nextScore.alpha / (nextScore.alpha + nextScore.beta);
-    return nextScore;
-  }
-}

package/lib/models/ChangeModel.ts

@@ -1,94 +0,0 @@
-import { Tuples } from "@shaxpir/shaxpir-common";
-import * as Changesets from 'json-diff-ts';
-import { Operation } from "json-diff-ts";
-import { Model } from "./Model";
-
-export interface ChangeItem {
-  type:Operation;
-  path:string;
-  value?:any;
-  oldValue?:any;
-}
-
-export interface ModelChange {
-  local:boolean;
-  model:Model;
-  items:ChangeItem[];
-  op:any[];
-}
-
-export class Changes {
-  public static withPathPrefix(change:ModelChange, prefix:string):boolean {
-    let matchingItems:ChangeItem[] = Changes.havingPathPrefix(change, prefix);
-    return matchingItems.length > 0;
-  }
-  public static havingPathPrefix(change:ModelChange, prefix:string):ChangeItem[] {
-    let matchingItems:ChangeItem[] = [];
-    const items = change.items;
-    for (let i = 0, len = items.length; i < len; i++) {
-      const item = items[i];
-      if (item.path.startsWith(prefix)) {
-        matchingItems.push(item);
-      }
-    }
-    return matchingItems;
-  }
-}
-
-// We have our own ChangeModel logic for performaning a diff between two objects. The main difference
-// between our model and the json-diff implementation is that we care about enumerating the full-path
-// to all modified model data elements, so that various GUI mediators can match against those paths
-// and decide whether or not to re-render a view. So, when a deeply-nested object is added into
-// another deeply nested object, the change-model should include the full path to all new R-Values
-// added in the change, rather than just the path to the root of the new tree branches.
-export class ChangeModel {
-  public static between(before:any, after:any):ChangeItem[] {
-    let changeItems:ChangeItem[] = [];
-    const diff = Changesets.flattenChangeset(
-      Changesets.diff(before, after)
-    );
-    for (let i = 0; i < diff.length; i++) {
-      let diffItem = diff[i];
-      let type:Operation = diffItem.type;
-      let path:string = diffItem.path;
-      let value:any = diffItem.value;
-      let oldValue:any = diffItem.oldValue;
-      let valueType:string = diffItem.valueType;
-      let key:string = diffItem.key;
-      if (valueType === 'Object' || valueType == 'Array') {
-        let tuples = Tuples.of(value);
-        let fullPath = path;
-        if (/^\d+$/.test(key) && !path.endsWith('[' + key + ']')) {
-          fullPath = path + '[' + key + ']';
-        }
-        if (!/^\d+$/.test(key) && !path.endsWith('.' + key)) {
-          fullPath = path + '.' + key;
-        }
-        if (tuples.length == 0) {
-          if (type == 'REMOVE') {
-            changeItems.push({ type : type,  path : fullPath, oldValue : value });
-          } else {
-            changeItems.push({ type : type,  path : fullPath, value : value, oldValue : oldValue });
-          }
-        } else {
-          for (let j = 0; j < tuples.length; j++) {
-            let tuple = tuples[j];
-            let fullTuplePath = Tuples.stringifyPath(fullPath, tuple.path);
-            if (type == 'REMOVE') {
-              changeItems.push({ type : type,  path : fullTuplePath, oldValue : tuple.val });
-            } else {
-              changeItems.push({ type : type,  path : fullTuplePath, value : tuple.val });
-            }
-          }
-        }
-      } else {
-        if (type == 'REMOVE') {
-          changeItems.push({ type : type,  path : path, oldValue : value });
-        } else {
-          changeItems.push({ type : type,  path : path, value : value, oldValue : oldValue });
-        }
-      }
-    }
-    return changeItems;
-  }
-}

package/lib/models/Content.ts

@@ -1,107 +0,0 @@
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { CompactDateTime, MultiTime, Struct } from '@shaxpir/shaxpir-common';
-import { ShareSync } from '../repo';
-import { ContentKind } from './ContentKind';
-import { DevicePayload } from './Device';
-import { MediaPayload } from './Media';
-import { MetricPayload } from './Metric';
-import { Model } from './Model';
-import { ProfilePayload } from "./Profile";
-import { ProgressPayload } from './Progress';
-import { SessionPayload } from './Session';
-import { TermPayload } from './Term';
-import { UserPayload } from './User';
-import { WorkspacePayload } from './Workspace';
-
-enum ContentIdBrand {}
-enum ContentRefBrand {}
-
-export type ContentId = string & ContentIdBrand;
-export type ContentRef = (string & ContentRefBrand) | ContentId;
-
-export interface ParsedContentRef {
-  id:ContentId;
-  kind?:ContentKind;
-  timestamp?:CompactDateTime;
-}
-
-export interface ContentBody {
-  meta:ContentMeta;
-  payload:ContentPayload;
-}
-
-export interface ContentMeta {
-  ref:ContentRef;
-  kind:ContentKind;
-  id:ContentId;
-  owner:ContentId;
-  created_at:MultiTime;
-  updated_at:MultiTime;
-}
-
-export type ContentPayload =
-  DevicePayload
-| MediaPayload
-| MetricPayload
-| ProfilePayload
-| ProgressPayload
-| SessionPayload
-| TermPayload
-| UserPayload
-| WorkspacePayload;
-
-export abstract class Content extends Model {
-
-  public static ID_LENGTH:number = 16;
-
-  constructor(doc:Doc, shouldAcquire:boolean, shareSync:ShareSync) {
-    super(doc, shouldAcquire, shareSync);
-  }
-
-  public get meta():ContentMeta {
-    this.checkDisposed("Content.meta");
-    return this.doc.data.meta as ContentMeta;
-  }
-
-  public get payload():ContentPayload {
-    this.checkDisposed("Content.payload");
-    return this.doc.data.payload as ContentPayload;
-  }
-
-  public cloneContentBody():ContentBody {
-    this.checkDisposed("Content.cloneContentBody");
-    if (this.exists()) {
-      return Struct.clone(this.doc.data);
-    } else {
-      return null;
-    }
-  }
-
-  public get id():ContentId {
-    this.checkDisposed("Content.id");
-    return this.meta.id as ContentId;
-  }
-
-  public get updatedAt():MultiTime {
-    this.checkDisposed("Content.updatedAt");
-    return this.meta.updated_at as MultiTime;
-  }
-
-  public get createdAt():MultiTime {
-    this.checkDisposed("Content.createdAt");
-    return this.meta.created_at as MultiTime;
-  }
-
-  public get owner():ContentId {
-    this.checkDisposed("Content.owner");
-    return this.meta.owner as ContentId;
-  }
-
-  public async modelUpdated():Promise<void> {
-    this.checkDisposed("Content.modelUpdated");
-    this.acquire();
-    await this.shareSync.updateManifestForContent(this);
-    this.release();
-  }
-
-}

package/lib/models/ContentKind.ts

@@ -1,19 +0,0 @@
-export enum ContentKind {
-
-  // 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",
-}