@shaxpir/duiduidui-models 1.0.0 → 1.1.0

package/dist/models/content/Migration.js

@@ -1,155 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Migration = exports.MigrationStatus = void 0;
-const ShareSync_1 = require("../../repo/ShareSync");
-const CachingHasher_1 = require("../../util/CachingHasher");
-const markup_1 = require("../markup");
-const Content_1 = require("./Content");
-const ContentKind_1 = require("./ContentKind");
-const Time_1 = require("./Time");
-var MigrationStatus;
-(function (MigrationStatus) {
-    MigrationStatus["MIGRATED"] = "MIGRATED";
-    MigrationStatus["CANT_MIGRATE"] = "CANT_MIGRATE";
-    MigrationStatus["REPAIRED"] = "REPAIRED";
-    MigrationStatus["CANT_REPAIR"] = "CANT_REPAIR";
-    MigrationStatus["SKIPPED"] = "SKIPPED";
-    MigrationStatus["UPDATED"] = "UPDATED";
-})(MigrationStatus || (exports.MigrationStatus = MigrationStatus = {}));
-class Migration extends Content_1.Content {
-    constructor(doc, shouldAcquire, shareSync) {
-        super(doc, shouldAcquire, shareSync);
-    }
-    static makeMigrationId(userId) {
-        return CachingHasher_1.CachingHasher.makeMd5ContentId(userId + "-" + ContentKind_1.ContentKind.MIGRATION);
-    }
-    static create(userId, isPrimary, deviceId) {
-        const now = Time_1.MultiClock.now();
-        const migrationId = Migration.makeMigrationId(userId);
-        const migrationRef = Content_1.Content.makeContentRef(migrationId, now.utc_time);
-        return ShareSync_1.ShareSyncFactory.get().createContent({
-            meta: {
-                ref: migrationRef,
-                is_head: false,
-                kind: ContentKind_1.ContentKind.MIGRATION,
-                id: migrationId,
-                owner: userId,
-                created_at: now,
-                updated_at: now
-            },
-            payload: {
-                start: now,
-                end: now,
-                is_complete: false,
-                is_primary: isPrimary,
-                device_id: deviceId,
-                legacy_snapshot_count: 0,
-                migrated_count: 0,
-                cant_migrate_count: 0,
-                repaired_count: 0,
-                cant_repair_count: 0,
-                updated_count: 0,
-                skipped_count: 0,
-                duration_minutes: 0,
-                migration_entries: []
-            }
-        });
-    }
-    get payload() {
-        this.checkDisposed("Migration.payload");
-        return this.doc.data.payload;
-    }
-    get durationMinutes() {
-        this.checkDisposed("Migration.durationMinutes");
-        return this.payload.duration_minutes;
-    }
-    get isPrimary() {
-        this.checkDisposed("Migration.isPrimary");
-        return this.payload.is_primary;
-    }
-    get isComplete() {
-        this.checkDisposed("Migration.isComplete");
-        return this.payload.is_complete;
-    }
-    setIsComplete(value) {
-        this.checkDisposed("Migration.setIsComplete");
-        if (this.isComplete != value) {
-            const batch = new markup_1.BatchOperation(this);
-            batch.setPathValue(['payload', 'is_complete'], value);
-            this.touch(batch, batch.at);
-            batch.commit();
-        }
-    }
-    get legacySnapshotCount() {
-        this.checkDisposed("Migration.legacySnapshotCount");
-        return this.payload.legacy_snapshot_count;
-    }
-    setLegacySnapshotCount(value) {
-        this.checkDisposed("Migration.setLegacySnapshotCount");
-        if (this.legacySnapshotCount != value) {
-            const batch = new markup_1.BatchOperation(this);
-            batch.setPathValue(['payload', 'legacy_snapshot_count'], value);
-            this.touch(batch, batch.at);
-            batch.commit();
-        }
-    }
-    get repairedCount() {
-        this.checkDisposed("Migration.repairedCount");
-        return this.payload.repaired_count;
-    }
-    get cantRepairCount() {
-        this.checkDisposed("Migration.cantRepairCount");
-        return this.payload.cant_repair_count;
-    }
-    get migratedCount() {
-        this.checkDisposed("Migration.migratedCount");
-        return this.payload.migrated_count;
-    }
-    get cantMigrateCount() {
-        this.checkDisposed("Migration.cantMigrateCount");
-        return this.payload.cant_migrate_count;
-    }
-    get updatedCount() {
-        this.checkDisposed("Migration.updatedCount");
-        return this.payload.updated_count;
-    }
-    get skippedCount() {
-        this.checkDisposed("Migration.skippedCount");
-        return this.payload.skipped_count;
-    }
-    addMigrationEntry(entry) {
-        this.checkDisposed("Migration.addMigrationEntry");
-        const batch = new markup_1.BatchOperation(this, entry.at);
-        const modelCount = entry.models.length;
-        batch.pushIntoArray(['payload', 'migration_entries'], entry);
-        this.touch(batch, entry.at);
-        switch (entry.status) {
-            case MigrationStatus.MIGRATED:
-                batch.setPathValue(['payload', 'migrated_count'], this.migratedCount + modelCount);
-                break;
-            case MigrationStatus.CANT_MIGRATE:
-                batch.setPathValue(['payload', 'cant_migrate_count'], this.cantMigrateCount + modelCount);
-                break;
-            case MigrationStatus.REPAIRED:
-                batch.setPathValue(['payload', 'repaired_count'], this.repairedCount + modelCount);
-                break;
-            case MigrationStatus.CANT_REPAIR:
-                batch.setPathValue(['payload', 'cant_repair_count'], this.cantRepairCount + modelCount);
-                break;
-            case MigrationStatus.UPDATED:
-                batch.setPathValue(['payload', 'updated_count'], this.updatedCount + modelCount);
-                break;
-            case MigrationStatus.SKIPPED:
-                batch.setPathValue(['payload', 'skipped_count'], this.skippedCount + modelCount);
-                break;
-        }
-        batch.commit();
-    }
-    touch(batch, at) {
-        const minutes = Time_1.Time.absDiffMinutes(at.utc_time, this.payload.start.utc_time);
-        batch.setPathValue(['payload', 'duration_minutes'], minutes);
-        batch.setPathValue(['payload', 'end', 'utc_time'], at.utc_time);
-        batch.setPathValue(['payload', 'end', 'local_time'], at.local_time);
-    }
-}
-exports.Migration = Migration;

package/dist/models/content/Phrase.d.ts

@@ -1,8 +0,0 @@
-import { ContentBody, ContentMeta } from "./Content";
-import { Definable, DictionaryEntry, Pronouncable } from "./DictionaryEntry";
-export interface PhrasePayload extends DictionaryEntry, Pronouncable, Definable {
-}
-export interface PhraseBody extends ContentBody {
-    meta: ContentMeta;
-    payload: PhrasePayload;
-}

package/dist/models/content/Placeholder.d.ts

@@ -1,8 +0,0 @@
-import { Content } from './Content';
-import { Stub } from './Stub';
-export declare class Placeholder {
-    static readonly PREFIX = "untitled";
-    static forCategory(name: string): string;
-    static forContent(content: Content): string;
-    static forStub(stub: Stub): string;
-}

package/dist/models/content/Placeholder.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Placeholder = void 0;
-const Text_1 = require("../../util/Text");
-const Book_1 = require("./Book");
-const ContentKind_1 = require("./ContentKind");
-const Fragment_1 = require("./Fragment");
-class Placeholder {
-    static forCategory(name) {
-        let placeholder = "untitled ";
-        if (typeof (name) !== "undefined") { // TODO: does anyone call this without an arg?
-            placeholder += name.trim();
-        }
-        return Text_1.Text.capitalizeWords(placeholder.trim());
-    }
-    static forContent(content) {
-        if (content instanceof Book_1.Book) {
-            return Placeholder.forCategory(ContentKind_1.ContentKind.BOOK);
-        }
-        else if (content instanceof Fragment_1.Fragment) {
-            return Placeholder.forCategory(content.category);
-        }
-        return Text_1.Text.capitalizeWords(content.kind);
-    }
-    static forStub(stub) {
-        if (stub.kind === ContentKind_1.ContentKind.BOOK) {
-            return Placeholder.forCategory(ContentKind_1.ContentKind.BOOK);
-        }
-        else if (stub.kind === ContentKind_1.ContentKind.FRAGMENT) {
-            return Placeholder.forCategory(stub.category);
-        }
-        return Text_1.Text.capitalizeWords(stub.kind);
-    }
-}
-exports.Placeholder = Placeholder;
-Placeholder.PREFIX = 'untitled';

package/dist/models/content/RichText.d.ts

@@ -1,58 +0,0 @@
-/// <reference path="../../../decs.d.ts" />
-import { Op as DeltaOp } from "@shaxpir/quill-delta";
-import { Doc } from '@shaxpir/sharedb/lib/client';
-import { ShareSync } from '../../repo/ShareSync';
-import { Checkpointable } from './Checkpointable';
-import { ContentId, ContentMeta } from "./Content";
-import { MultiTime } from './Time';
-export interface FormatAttr {
-    align?: string;
-    blockquote?: boolean;
-    bold?: boolean;
-    comment?: ContentId[];
-    header?: number;
-    highlight?: any[];
-    indent?: number;
-    italic?: boolean;
-    link?: string;
-    list?: "ordered" | "bullet";
-    script: "sub" | "super";
-    strike?: boolean;
-    underline?: boolean;
-}
-export interface FormatEmbed {
-    divider?: boolean;
-}
-export interface Format {
-    at: number;
-    len: number;
-    attr?: FormatAttr;
-    embed?: FormatEmbed;
-}
-export declare enum RichTextFlavor {
-    quill = "quill"
-}
-export interface QuillDoc {
-    ops: DeltaOp[];
-}
-export interface RichTextPayload {
-    richtext_flavor: RichTextFlavor;
-    richtext_body: QuillDoc;
-    word_count: number;
-}
-export interface RichTextBody {
-    meta: ContentMeta;
-    payload: RichTextPayload;
-}
-export declare abstract class RichText extends Checkpointable {
-    constructor(doc: Doc, shouldAcquire: boolean, shareSync: ShareSync);
-    get payload(): RichTextPayload;
-    get richtextFlavor(): RichTextFlavor;
-    get richtextBody(): QuillDoc;
-    get wordCount(): number;
-    setWordCount(value: number): void;
-    get mediaIds(): ContentId[];
-    get commentIds(): ContentId[];
-    updateRichText(deltaOps: DeltaOp[], newWordCount: number): void;
-    beforeRestoreTo(checkpoint: Checkpointable, now: MultiTime): Promise<void>;
-}

package/dist/models/content/RichText.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RichText = exports.RichTextFlavor = void 0;
-const util_1 = require("../../util");
-const markup_1 = require("../markup");
-const BodyFormat_1 = require("../markup/BodyFormat");
-const Checkpointable_1 = require("./Checkpointable");
-const ContentKind_1 = require("./ContentKind");
-var RichTextFlavor;
-(function (RichTextFlavor) {
-    RichTextFlavor["quill"] = "quill";
-})(RichTextFlavor || (exports.RichTextFlavor = RichTextFlavor = {}));
-class RichText extends Checkpointable_1.Checkpointable {
-    constructor(doc, shouldAcquire, shareSync) {
-        super(doc, shouldAcquire, shareSync);
-    }
-    get payload() {
-        this.checkDisposed("RichText.payload");
-        return this.doc.data.payload;
-    }
-    get richtextFlavor() {
-        this.checkDisposed("RichText.richtextFlavor");
-        return this.payload.richtext_flavor;
-    }
-    get richtextBody() {
-        this.checkDisposed("RichText.richtextBody");
-        return this.payload.richtext_body;
-    }
-    get wordCount() {
-        this.checkDisposed("RichText.wordCount");
-        return this.payload.word_count;
-    }
-    setWordCount(value) {
-        this.checkDisposed("RichText.setWordCount");
-        if (this.wordCount !== value) {
-            const batch = new markup_1.BatchOperation(this);
-            batch.setPathValue(['payload', 'word_count'], value);
-            batch.commit();
-        }
-    }
-    get mediaIds() {
-        this.checkDisposed("RichText.mediaIds");
-        return BodyFormat_1.BodyFormatModel.getMediaIdsFromDeltaOps(this.richtextBody.ops);
-    }
-    get commentIds() {
-        this.checkDisposed("RichText.commentIds");
-        return BodyFormat_1.BodyFormatModel.getCommentIdsFromDeltaOps(this.richtextBody.ops);
-    }
-    updateRichText(deltaOps, newWordCount) {
-        this.checkDisposed("RichText.updateRichText");
-        const batch = new markup_1.BatchOperation(this);
-        batch.applyRichText(['payload', 'richtext_body'], deltaOps);
-        if (this.wordCount != newWordCount) {
-            batch.setPathValue(['payload', 'word_count'], newWordCount);
-        }
-        batch.commit();
-    }
-    async beforeRestoreTo(checkpoint, now) {
-        this.checkDisposed("RichText.beforeRestoreTo");
-        // Restore all embedded comments
-        const checkpointTimestamp = checkpoint.createdAt.utc_time;
-        const commentIds = this.commentIds;
-        if (commentIds.length > 0) {
-            for (let i = 0; i < commentIds.length; i++) {
-                const commentId = commentIds[i];
-                const commentHead = await this.shareSync.acquire(ContentKind_1.ContentKind.COMMENT, commentId);
-                const commentCheckpoint = await commentHead.acquireLatestCheckpointAt(checkpointTimestamp);
-                // If the HEAD comment is already the most recent checkpoint, or if the payload hasn't
-                // changed since that checkpoint was taken, then there's no need to restore this comment.
-                if (!commentCheckpoint.isHead && !util_1.Struct.equals(commentHead.payload, commentCheckpoint.payload)) {
-                    await commentHead.restoreTo(commentCheckpoint, now);
-                }
-                commentCheckpoint.release();
-                commentHead.release();
-            }
-        }
-    }
-}
-exports.RichText = RichText;

package/dist/models/content/Session.js

@@ -1,173 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Session = void 0;
-const ShareSync_1 = require("../../repo/ShareSync");
-const CachingHasher_1 = require("../../util/CachingHasher");
-const Struct_1 = require("../../util/Struct");
-const Operation_1 = require("../markup/Operation");
-const Content_1 = require("./Content");
-const ContentKind_1 = require("./ContentKind");
-const Metric_1 = require("./Metric");
-const Time_1 = require("./Time");
-const Workspace_1 = require("./Workspace");
-class Session extends Content_1.Content {
-    static makeSessionId(userId) {
-        return CachingHasher_1.CachingHasher.makeMd5ContentId(userId + "-" + ContentKind_1.ContentKind.SESSION);
-    }
-    static create(userId, deviceId, environment) {
-        let now = Time_1.MultiClock.now();
-        let sessionId = Session.makeSessionId(userId);
-        let sessionRef = Content_1.Content.makeContentRef(sessionId, now.utc_time);
-        return ShareSync_1.ShareSyncFactory.get().createContent({
-            meta: {
-                ref: sessionRef,
-                is_head: false,
-                kind: ContentKind_1.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,
-                environment: environment,
-                word_count: 0,
-                activity: []
-            }
-        });
-    }
-    constructor(doc, shouldAcquire, shareSync) {
-        super(doc, shouldAcquire, shareSync);
-    }
-    get payload() {
-        this.checkDisposed("Session.payload");
-        return this.doc.data.payload;
-    }
-    touch() {
-        this.checkDisposed("Session.touch");
-        const batch = new Operation_1.BatchOperation(this);
-        let nowUtc = batch.at.utc_time;
-        let nowLocal = batch.at.local_time;
-        let minutes = Time_1.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();
-    }
-    get start() {
-        this.checkDisposed("Session.start");
-        return this.payload.start;
-    }
-    get end() {
-        this.checkDisposed("Session.end");
-        return this.payload.end;
-    }
-    get tzOffset() {
-        this.checkDisposed("Session.tzOffset");
-        return this.payload.tz_offset;
-    }
-    get durationMinutes() {
-        this.checkDisposed("Session.durationMinutes");
-        return this.payload.duration_minutes;
-    }
-    get deviceId() {
-        this.checkDisposed("Session.deviceId");
-        return this.payload.device_id;
-    }
-    get environment() {
-        this.checkDisposed("Session.environment");
-        return this.payload.environment;
-    }
-    get wordCount() {
-        this.checkDisposed("Session.wordCount");
-        return this.payload.word_count;
-    }
-    setWordCount(value) {
-        this.checkDisposed("Session.setWordCount");
-        if (this.wordCount !== value) {
-            const batch = new Operation_1.BatchOperation(this);
-            batch.setPathValue(['payload', 'word_count'], value);
-            batch.commit();
-        }
-    }
-    get activity() {
-        this.checkDisposed("Session.activity");
-        return this.payload.activity;
-    }
-    recordActivity(newActivity) {
-        this.checkDisposed("Session.recordActivity");
-        // TODO: instead of rebuilding the activity list completely on every change,
-        // update only the deeply-nested fields within the Activity array.
-        let newActivities = [];
-        let replaced = false;
-        // Iterate through the activities in the session, replacing any existing activities with new ones (having
-        // updated word-counts and timestamps) and summing them all up to produce the session-total-word-count.
-        let sessionWordCount = 0;
-        let existingActivities = this.payload.activity;
-        for (let i = 0, len = existingActivities.length; i < len; i++) {
-            let existingActivity = existingActivities[i];
-            if (existingActivity.id === newActivity.id) {
-                if (newActivity.hasOwnProperty("word_count")) {
-                    sessionWordCount += newActivity.word_count;
-                }
-                newActivities.push(newActivity);
-                replaced = true;
-            }
-            else {
-                newActivities.push(existingActivity);
-                if (existingActivity.hasOwnProperty("word_count")) {
-                    sessionWordCount += existingActivity.word_count;
-                }
-            }
-        }
-        if (replaced === false) {
-            newActivities.push(newActivity);
-            if (newActivity.hasOwnProperty("word_count")) {
-                sessionWordCount += newActivity.word_count;
-            }
-        }
-        const now = Time_1.MultiClock.now();
-        const batch = new Operation_1.BatchOperation(this, now);
-        batch.setPathValue(['payload', 'end'], now);
-        if (this.wordCount !== sessionWordCount) {
-            batch.setPathValue(['payload', 'word_count'], sessionWordCount);
-        }
-        if (!Struct_1.Struct.equals(existingActivities, newActivities)) {
-            batch.setPathValue(['payload', 'activity'], newActivities);
-        }
-        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 = Time_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);
-        workspace.release();
-        let wordCountOnDate = 0;
-        let minutesWritingOnDate = 0;
-        for (let i = 0, len = sessionsOnDate.length; i < len; i++) {
-            const sessionOnDate = sessionsOnDate[i];
-            wordCountOnDate += sessionOnDate.wordCount;
-            minutesWritingOnDate += sessionOnDate.durationMinutes;
-            sessionOnDate.release();
-        }
-        const wordCountMetricId = Metric_1.Metric.makeMetricId(userId, Metric_1.MetricName.WORD_COUNT);
-        const wordCountMetric = await shareSync.acquire(ContentKind_1.ContentKind.METRIC, wordCountMetricId);
-        wordCountMetric.setDateAmount(date, wordCountOnDate);
-        wordCountMetric.release();
-        const minutesWritingMetricId = Metric_1.Metric.makeMetricId(userId, Metric_1.MetricName.MINUTES_WRITING);
-        const minutesWritingMetric = await shareSync.acquire(ContentKind_1.ContentKind.METRIC, minutesWritingMetricId);
-        minutesWritingMetric.setDateAmount(date, minutesWritingOnDate);
-        minutesWritingMetric.release();
-    }
-}
-exports.Session = Session;

package/dist/models/content/Speech.d.ts

@@ -1,67 +0,0 @@
-export declare enum SpeechDataType {
-    AUDIO_MP3 = "audio_mp3",
-    AUDIO_OGG = "audio_ogg",
-    META_WORD_MARKS = "meta_word_marks"
-}
-export declare enum SpeechProvider {
-    AWS = "aws",
-    ELEVEN_LABS = "eleven_labs"
-}
-export declare enum SpeechEngine {
-    STANDARD = "standard",
-    NEURAL = "neural"
-}
-export declare enum SpeechLanguage {
-    ENGLISH = "English"
-}
-export declare enum SpeechDialect {
-    US = "US",
-    AU = "AU",
-    GB = "GB",
-    IN = "IN"
-}
-export declare enum SpeechGender {
-    MALE = "Male",
-    FEMALE = "Female"
-}
-export declare enum SpeechAge {
-    ADULT = "Adult",
-    CHILD = "Child",
-    ELDERLY = "Elderly"
-}
-export interface SpeechMarkItem {
-    time: number;
-    type: string;
-    start: number;
-    end: number;
-    value: string;
-}
-export declare class SpeechPersona {
-    static readonly AMY: SpeechPersona;
-    static readonly BRIAN: SpeechPersona;
-    static readonly EMMA: SpeechPersona;
-    static readonly IVY: SpeechPersona;
-    static readonly JOANNA: SpeechPersona;
-    static readonly JOEY: SpeechPersona;
-    static readonly JUSTIN: SpeechPersona;
-    static readonly KENDRA: SpeechPersona;
-    static readonly KEVIN: SpeechPersona;
-    static readonly KIMBERY: SpeechPersona;
-    static readonly MATTHEW: SpeechPersona;
-    static readonly SALLI: SpeechPersona;
-    static readonly DAVID: SpeechPersona;
-    static readonly RACHEL: SpeechPersona;
-    static readonly DEFAULT: SpeechPersona;
-    static readonly ALL: SpeechPersona[];
-    code: string;
-    name: string;
-    provider: SpeechProvider;
-    engine: SpeechEngine;
-    language: SpeechLanguage;
-    dialect: SpeechDialect;
-    gender: SpeechGender;
-    age: SpeechAge;
-    constructor(code: string, name: string, provider: SpeechProvider, engine: SpeechEngine, language: SpeechLanguage, dialect: SpeechDialect, gender: SpeechGender, age: SpeechAge);
-    static byName(name: string): SpeechPersona;
-    getLangaugeCode(): string;
-}