notu 0.2.1 → 0.2.3

package/src/models/Note.ts

@@ -1,204 +0,0 @@
-'use strict';
-
-import ModelWithState from './ModelWithState';
-import NoteAttr from './NoteAttr';
-import NoteTag from './NoteTag';
-import Space from './Space';
-import Tag from './Tag';
-import Attr from './Attr';
-
-
-export default class Note extends ModelWithState<Note> {
-    id: number = 0;
-
-
-    private _date: Date = new Date();
-    get date(): Date { return this._date; }
-    set date(value: Date) {
-        if (value !== this._date) {
-            this._date = value;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-
-    private _text: string = '';
-    get text(): string { return this._text; }
-    set text(value: string) {
-        if (value !== this._text) {
-            this._text = value;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-
-    private _archived: boolean = false;
-    get archived(): boolean { return this._archived; }
-    set archived(value: boolean) {
-        if (value !== this._archived) {
-            this._archived = value;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-
-    private _spaceId: number = 0;
-    get spaceId(): number { return this._spaceId; }
-    set spaceId(value: number) {
-        if (value !== this._spaceId) {
-            this._spaceId = value;
-            if (value !== this.space?.id ?? 0)
-                this._space = null;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-    private _space: Space = null;
-    get space(): Space { return this._space; }
-    set space(value: Space) {
-        this._space = value;
-        this.spaceId = value?.id ?? 0;
-    }
-
-
-    private _ownTag: Tag = null;
-    get ownTag(): Tag { return this._ownTag; }
-
-    setOwnTag(tag: string | Tag): Note {
-        if (typeof tag === 'string') {
-            if (this.ownTag == null)
-                this._ownTag = new Tag();
-            this.ownTag.name = tag;
-            this.ownTag.id = this.id;
-        }
-        else {
-            if (!!this.ownTag)
-                throw new Error('Note has already had its tag set. If you would like to change the tag name, call setTag with just a string specifying the new tag name.');
-            if (tag.id != 0 && tag.id != this.id)
-                throw new Error('Attempted to set tag to note with non-matching ID. Added tag id must either match the note id, which indicates that the tag has already been added to the note. Otherwise the tag id must be zero, indicating that the tag still needs to be added.')
-            this._ownTag = tag;
-        }
-        return this;
-    }
-
-    removeOwnTag(): Note {
-        if (!this.ownTag)
-            return;
-        if (this.ownTag.isNew)
-            this._ownTag = null;
-        else
-            this.ownTag.delete();
-    }
-
-
-    private _tags: Array<NoteTag> = [];
-    get tags(): Array<NoteTag> { return this._tags; }
-
-    addTag(tag: Tag): NoteTag {
-        if (tag.isDeleted)
-            throw Error('Cannot add a tag marked as deleted to a note');
-        if (tag.isNew)
-            throw Error('Cannot add a tag that hasn\'t yet been saved to a note');
-        if (tag.id == this.id)
-            throw Error('Note cannot add its own tag as a linked tag');
-        let nt = this.tags.find(x => x.tagId == tag.id);
-        if (!!nt) {
-            if (nt.isDeleted)
-                nt.dirty();
-            return nt;
-        }
-        nt = new NoteTag();
-        nt.note = this;
-        nt.tag = tag;
-        this._tags.push(nt);
-        return nt;
-    }
-
-    removeTag(tag: Tag): Note {
-        const nt = this.tags.find(x => x.tagId == tag.id);
-        if (!nt)
-            return this;
-
-        if (nt.isNew)
-            this._tags = this._tags.filter(x => x !== nt);
-        else
-            nt.delete();
-        return this;
-    }
-
-
-    private _attrs: Array<NoteAttr> = [];
-    get attrs(): Array<NoteAttr> { return this._attrs; }
-
-    addAttr(attr: Attr): NoteAttr {
-        if (attr.isDeleted)
-            throw Error('Cannot add an attribute marked as deleted to a note');
-        if (attr.isNew)
-            throw Error('Cannot add an attribute that hasn\'t yet been saved to a note');
-        let na = this.attrs.find(x => x.attrId == attr.id);
-        if (!!na) {
-            if (na.isDeleted)
-                na.dirty();
-            return na;
-        }
-        na = new NoteAttr();
-        na.note = this;
-        na.attr = attr;
-        this._attrs.push(na);
-        return na;
-    }
-
-    removeAttr(attr: Attr): Note {
-        const na = this.attrs.find(x => x.attrId == attr.id);
-        if (!na)
-            return this;
-
-        if (na.isNew)
-            this._attrs = this._attrs.filter(x => x !== na);
-        else
-            na.delete();
-        return this;
-    }
-
-
-    duplicate(): Note {
-        const output = new Note();
-        output.id = this.id;
-        output.date = this.date;
-        output.text = this.text;
-        output.archived = this.archived;
-        output.space = this.space;
-        output.state = this.state;
-        return output;
-    }
-
-
-    validate(throwError: boolean = false): boolean {
-        let output = null;
-
-        if (this.spaceId <= 0)
-            output = 'Note spaceId must be greater than zero.';
-        else if (!this.isNew && this.id <= 0)
-            output = 'Note id must be greater than zero if in non-new state.';
-
-        if (throwError && output != null)
-            throw Error(output);
-
-        if (!!this.ownTag && !this.ownTag.validate(throwError))
-            return false;
-        for (const nt of this.tags) {
-            if (!nt.validate(throwError))
-                return false;
-        }
-        for (const na of this.attrs) {
-            if (!na.validate(throwError))
-                return false;
-        }
-
-        return output == null;
-    }
-}

package/src/models/NoteAttr.test.ts

@@ -1,358 +0,0 @@
-import { expect, test } from 'vitest';
-import NoteAttr from './NoteAttr';
-import Note from './Note';
-import Attr from './Attr';
-import Tag from './Tag';
-
-
-test('Gets initiated as new', () => {
-    const na = new NoteAttr();
-    expect(na.isNew).toBe(true);
-});
-
-test('Gets initiated with sensible defaults', () => {
-    const na = new NoteAttr();
-    expect(na.noteId).toBe(0);
-    expect(na.attrId).toBe(0);
-    expect(na.value).toBe(null);
-    expect(na.tagId).toBe(null);
-});
-
-
-test('Set noteId marks object as dirty if currently clean', () => {
-    const na = new NoteAttr().clean();
-    na.noteId = 123;
-    expect(na.isDirty).toBe(true);
-});
-
-test('Set noteId doesnt change state if new', () => {
-    const na = new NoteAttr().new();
-    na.noteId = 123;
-    expect(na.isNew).toBe(true);
-});
-
-test('Set noteId doesnt change state if value not different', () => {
-    const na = new NoteAttr().clean();
-    na.noteId = na.noteId;
-    expect(na.isClean).toBe(true);
-});
-
-test('Setting note with id different than current noteId updates state', () => {
-    const na = new NoteAttr();
-    na.noteId = 123;
-    na.clean();
-    const note = new Note();
-    note.id = 234;
-
-    na.note = note;
-
-    expect(na.noteId).toBe(234);
-    expect(na.isDirty).toBe(true);
-});
-
-test('Setting note with id same as current noteId preserves state', () => {
-    const na = new NoteAttr();
-    na.noteId = 27;
-    na.clean();
-    const note = new Note();
-    note.id = 27;
-
-    na.note = note;
-
-    expect(na.noteId).toBe(27);
-    expect(na.isClean).toBe(true);
-});
-
-test('Setting noteId to new value removes note object', () => {
-    const na = new NoteAttr();
-    const note = new Note();
-    note.id = 80;
-    na.note = note;
-
-    na.noteId = 81;
-
-    expect(na.note).toBeNull();
-});
-
-test('Setting noteId to same as current note id preserves it', () => {
-    const na = new NoteAttr();
-    const note = new Note();
-    note.id = 80;
-    na.note = note;
-
-    na.noteId = 80;
-
-    expect(na.note).not.toBeNull();
-});
-
-
-test('Set attrId marks object as dirty if currently clean', () => {
-    const na = new NoteAttr().clean();
-    na.attrId = 123;
-    expect(na.isDirty).toBe(true);
-});
-
-test('Set attrId doesnt change state if new', () => {
-    const na = new NoteAttr().new();
-    na.attrId = 123;
-    expect(na.isNew).toBe(true);
-});
-
-test('Set attrId doesnt change state if value not different', () => {
-    const na = new NoteAttr().clean();
-    na.attrId = na.attrId;
-    expect(na.isClean).toBe(true);
-});
-
-test('Setting attr with id different than current attrId updates state', () => {
-    const na = new NoteAttr();
-    na.attrId = 123;
-    na.clean();
-    const attr = new Attr();
-    attr.id = 234;
-
-    na.attr = attr;
-
-    expect(na.attrId).toBe(234);
-    expect(na.isDirty).toBe(true);
-});
-
-test('Setting attr with id same as current attrId preserves state', () => {
-    const na = new NoteAttr();
-    na.attrId = 27;
-    na.value = '';
-    na.clean();
-    const attr = new Attr();
-    attr.id = 27;
-
-    na.attr = attr;
-
-    expect(na.attrId).toBe(27);
-    expect(na.isClean).toBe(true);
-});
-
-test('Setting attrId to new value removes attr object', () => {
-    const na = new NoteAttr();
-    const attr = new Attr();
-    attr.id = 80;
-    na.attr = attr;
-
-    na.attrId = 81;
-
-    expect(na.attr).toBeNull();
-});
-
-test('Setting attrId to same as current attr id preserves it', () => {
-    const na = new NoteAttr();
-    const attr = new Attr();
-    attr.id = 80;
-    na.attr = attr;
-
-    na.attrId = 80;
-
-    expect(na.attr).not.toBeNull();
-});
-
-test('Setting attr updates the default value', () => {
-    const na = new NoteAttr();
-    const attr1 = new Attr().asNumber();
-    attr1.id = 1;
-
-    na.attr = attr1;
-
-    expect(na.value).toBe(0);
-});
-
-test('Setting attr to null clears out value', () => {
-    const na = new NoteAttr();
-    const attr = new Attr().asNumber();
-    attr.id = 1;
-    na.attr = attr;
-
-    na.attr = null;
-
-    expect(na.value).toBe(null);
-});
-
-test('Setting attr to new value of same type doesnt update value', () => {
-    const na = new NoteAttr();
-    const attr1 = new Attr().asNumber();
-    const attr2 = new Attr().asNumber();
-    attr1.id = 1;
-    attr2.id = 2;
-    na.attr = attr1;
-    na.value = 123;
-
-    na.attr = attr2;
-
-    expect(na.value).toBe(123);
-});
-
-test('Setting attr to new value of different type does update value', () => {
-    const na = new NoteAttr();
-    const attr1 = new Attr().asNumber();
-    const attr2 = new Attr().asText();
-    attr1.id = 1;
-    attr2.id = 2;
-    na.attr = attr1;
-    na.value = 123;
-
-    na.attr = attr2;
-
-    expect(na.value).toBe('');
-});
-
-
-test('Set value marks object as dirty if currently clean', () => {
-    const na = new NoteAttr().clean();
-    na.value = 123;
-    expect(na.isDirty).toBe(true);
-});
-
-test('Set value doesnt change state if new', () => {
-    const na = new NoteAttr().new();
-    na.value = 123;
-    expect(na.isNew).toBe(true);
-});
-
-test('Set value doesnt change state if value not different', () => {
-    const na = new NoteAttr().clean();
-    na.value = na.value;
-    expect(na.isClean).toBe(true);
-});
-
-
-test('Set tagId marks object as dirty if currently clean', () => {
-    const na = new NoteAttr().clean();
-    na.tagId = 123;
-    expect(na.isDirty).toBe(true);
-});
-
-test('Set tagId doesnt change state if new', () => {
-    const na = new NoteAttr().new();
-    na.tagId = 123;
-    expect(na.isNew).toBe(true);
-});
-
-test('Set tagId doesnt change state if value not different', () => {
-    const na = new NoteAttr().clean();
-    na.tagId = na.tagId;
-    expect(na.isClean).toBe(true);
-});
-
-test('Setting tag with id different than current tagId updates state', () => {
-    const na = new NoteAttr();
-    na.tagId = 123;
-    na.clean();
-    const tag = new Tag();
-    tag.id = 234;
-
-    na.tag = tag;
-
-    expect(na.tagId).toBe(234);
-    expect(na.isDirty).toBe(true);
-});
-
-test('Setting tag with id same as current tagId preserves state', () => {
-    const na = new NoteAttr();
-    na.tagId = 27;
-    na.clean();
-    const tag = new Tag();
-    tag.id = 27;
-
-    na.tag = tag;
-
-    expect(na.tagId).toBe(27);
-    expect(na.isClean).toBe(true);
-});
-
-test('Setting tagId to new value removes tag object', () => {
-    const na = new NoteAttr();
-    const tag = new Tag();
-    tag.id = 80;
-    na.tag = tag;
-
-    na.tagId = 81;
-
-    expect(na.tag).toBeNull();
-});
-
-test('Setting tagId to same as current tag id preserves it', () => {
-    const na = new NoteAttr();
-    const tag = new Tag();
-    tag.id = 80;
-    na.tag = tag;
-
-    na.tagId = 80;
-
-    expect(na.tag).not.toBeNull();
-});
-
-test('Setting tag to null also nulls tagId', () => {
-    const na = new NoteAttr();
-    const tag = new Tag();
-    tag.id = 80;
-    na.tag = tag;
-    expect(na.tagId).toBe(80);
-
-    na.tag = null;
-
-    expect(na.tagId).toBe(null);
-});
-
-
-test('Can duplicate itself', () => {
-    const na = new NoteAttr();
-    const note = new Note();
-    note.id = 24;
-    const attr = new Attr();
-    attr.id = 25;
-    const tag = new Tag();
-    tag.id = 26;
-    na.note = note;
-    na.attr = attr;
-    na.tag = tag;
-    na.value = 'hello';
-
-    const copy = na.duplicate();
-
-    expect(copy.note).toBe(na.note);
-    expect(copy.noteId).toBe(na.noteId);
-    expect(copy.attr).toBe(na.attr);
-    expect(copy.attrId).toBe(na.attrId);
-    expect(copy.tag).toBe(na.tag);
-    expect(copy.tagId).toBe(na.tagId);
-    expect(copy.value).toBe(na.value);
-});
-
-
-test('validate passes if noteId is 0 and state is new', () => {
-    const nt = new NoteAttr();
-    nt.attrId = 123;
-    expect(nt.validate()).toBe(true);
-});
-
-test('validate fails if noteId is 0 and state is not new', () => {
-    const nt = new NoteAttr();
-    nt.attrId = 123;
-    nt.clean();
-    expect(nt.validate()).toBe(false);
-});
-
-test('validate fails if attrId is 0', () => {
-    const nt = new NoteAttr();
-    nt.noteId = 123;
-    expect(nt.validate()).toBe(false);
-});
-
-test('validate throws error if arg set to true', () => {
-    const nt = new NoteAttr();
-    expect(() => nt.validate(true)).toThrowError();
-});
-
-test('validate succeeds if noteId & attrId are both positive values', () => {
-    const nt = new NoteAttr();
-    nt.noteId = 123;
-    nt.attrId = 234;
-    expect(nt.validate()).toBe(true);
-});

package/src/models/NoteAttr.ts

@@ -1,113 +0,0 @@
-'use strict';
-
-import ModelWithState from './ModelWithState';
-import Note from './Note';
-import Attr from './Attr';
-import Tag from './Tag';
-
-
-export default class NoteAttr extends ModelWithState<NoteAttr> {
-    private _noteId: number = 0;
-    get noteId(): number { return this._noteId; }
-    set noteId(value: number) {
-        if (value !== this._noteId) {
-            this._noteId = value;
-            if (value !== this.note?.id ?? 0)
-                this._note = null;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-    private _note: Note = null;
-    get note(): Note { return this._note; }
-    set note(value: Note) {
-        this._note = value;
-        this.noteId = value?.id ?? 0;
-    }
-
-
-    private _attrId: number = 0;
-    get attrId(): number { return this._attrId; }
-    set attrId(value: number) {
-        if (value !== this._attrId) {
-            this._attrId = value;
-            if (value !== this.attr?.id ?? 0)
-                this._attr = null;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-    private _attr: Attr = null;
-    get attr(): Attr { return this._attr; }
-    set attr(newAttr: Attr) {
-        const oldAttr = this._attr;
-        this._attr = newAttr;
-        if (!!newAttr) {
-            if (!oldAttr || newAttr.type != oldAttr.type)
-                this.value = newAttr.defaultValue;
-        }
-        else
-            this.value = null;
-        this.attrId = newAttr?.id ?? 0;
-    }
-
-
-    private _value: any = null;
-    get value(): any { return this._value; }
-    set value(newVal: any) {
-        if (newVal != this._value) {
-            this._value = newVal;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-
-    private _tagId: number = null;
-    get tagId(): number { return this._tagId; }
-    set tagId(value: number) {
-        if (value !== this._tagId) {
-            this._tagId = value;
-            if (value !== this.tag?.id)
-                this._tag = null;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-    private _tag: Tag = null;
-    get tag(): Tag { return this._tag; }
-    set tag(value: Tag) {
-        this._tag = value;
-        this.tagId = value?.id ?? null;
-    }
-
-
-    duplicate(): NoteAttr {
-        const output = new NoteAttr();
-        output.noteId = this.noteId;
-        output.note = this.note;
-        output.attrId = this.attrId;
-        output.attr = this.attr;
-        output.tagId = this.tagId;
-        output.tag = this.tag;
-        output.value = this.value;
-        return output;
-    }
-
-
-    validate(throwError: boolean = false): boolean {
-        let output = null;
-
-        if (this.noteId <= 0 && !this.isNew)
-            output = 'NoteAttr noteId must be greater than zero';
-        else if (this.attrId <= 0)
-            output = 'NoteAttr attrId must be greater than zero';
-
-        if (throwError && output != null)
-            throw Error(output);
-        return output == null;
-    }
-}