notu 0.2.0 → 0.2.2

package/src/models/NoteTag.test.ts

@@ -1,245 +0,0 @@
-import { expect, test } from 'vitest';
-import NoteTag from './NoteTag';
-import Note from './Note';
-import Tag from './Tag';
-import Attr from './Attr';
-
-
-test('Gets initiated as new', () => {
-    const nt = new NoteTag();
-    expect(nt.isNew).toBe(true);
-});
-
-test('Gets initiated with sensible defaults', () => {
-    const nt = new NoteTag();
-    expect(nt.noteId).toBe(0);
-    expect(nt.tagId).toBe(0);
-});
-
-test('Can duplicate itself', () => {
-    const nt = new NoteTag();
-    nt.noteId = 123;
-    nt.tagId = 234;
-    const copy = nt.duplicate();
-    expect(copy.noteId).toBe(nt.noteId);
-    expect(copy.tagId).toBe(nt.tagId);
-});
-
-
-test('Set noteId marks object as dirty if currently clean', () => {
-    const nt = new NoteTag().clean();
-    nt.noteId = 123;
-    expect(nt.isDirty).toBe(true);
-});
-
-test('Set noteId doesnt change state if new', () => {
-    const nt = new NoteTag().new();
-    nt.noteId = 123;
-    expect(nt.isNew).toBe(true);
-});
-
-test('Set noteId doesnt change state if value not different', () => {
-    const nt = new NoteTag().clean();
-    nt.noteId = nt.noteId;
-    expect(nt.isClean).toBe(true);
-});
-
-
-test('Set tagId marks object as dirty if currently clean', () => {
-    const nt = new NoteTag().clean();
-    nt.tagId = 123;
-    expect(nt.isDirty).toBe(true);
-});
-
-test('Set tagId doesnt change state if new', () => {
-    const nt = new NoteTag().new();
-    nt.tagId = 123;
-    expect(nt.isNew).toBe(true);
-});
-
-test('Set tagId doesnt change state if value not different', () => {
-    const nt = new NoteTag().clean();
-    nt.tagId = nt.tagId;
-    expect(nt.isClean).toBe(true);
-});
-
-
-test('Setting note with id different than current noteId updates state', () => {
-    const nt = new NoteTag();
-    nt.noteId = 123;
-    nt.clean();
-    const note = new Note();
-    note.id = 234;
-
-    nt.note = note;
-
-    expect(nt.noteId).toBe(234);
-    expect(nt.isDirty).toBe(true);
-});
-
-test('Setting note with id same as current noteId preserves state', () => {
-    const nt = new NoteTag();
-    nt.noteId = 27;
-    nt.clean();
-    const note = new Note();
-    note.id = 27;
-
-    nt.note = note;
-
-    expect(nt.noteId).toBe(27);
-    expect(nt.isClean).toBe(true);
-});
-
-test('Setting noteId to new value removes note object', () => {
-    const nt = new NoteTag();
-    const note = new Note();
-    note.id = 80;
-    nt.note = note;
-
-    nt.noteId = 81;
-
-    expect(nt.note).toBeNull();
-});
-
-test('Setting noteId to same as current note id preserves it', () => {
-    const nt = new NoteTag();
-    const note = new Note();
-    note.id = 80;
-    nt.note = note;
-
-    nt.noteId = 80;
-
-    expect(nt.note).not.toBeNull();
-});
-
-
-test('Setting tag with id different than current tagId updates state', () => {
-    const nt = new NoteTag();
-    nt.tagId = 123;
-    nt.clean();
-    const tag = new Tag();
-    tag.id = 234;
-
-    nt.tag = tag;
-
-    expect(nt.tagId).toBe(234);
-    expect(nt.isDirty).toBe(true);
-});
-
-test('Setting tag with id same as current tagId preserves state', () => {
-    const nt = new NoteTag();
-    nt.tagId = 27;
-    nt.clean();
-    const tag = new Tag();
-    tag.id = 27;
-
-    nt.tag = tag;
-
-    expect(nt.tagId).toBe(27);
-    expect(nt.isClean).toBe(true);
-});
-
-test('Setting tagId to new value removes tag object', () => {
-    const nt = new NoteTag();
-    const tag = new Tag();
-    tag.id = 80;
-    nt.tag = tag;
-
-    nt.tagId = 81;
-
-    expect(nt.tag).toBeNull();
-});
-
-test('Setting tagId to same as current tag id preserves it', () => {
-    const nt = new NoteTag();
-    const tag = new Tag();
-    tag.id = 80;
-    nt.tag = tag;
-
-    nt.tagId = 80;
-
-    expect(nt.tag).not.toBeNull();
-});
-
-
-test('validate passes if noteId is 0 and state is new', () => {
-    const nt = new NoteTag();
-    nt.tagId = 123;
-    expect(nt.validate()).toBe(true);
-});
-
-test('validate fails if noteId is 0 and state is not new', () => {
-    const nt = new NoteTag();
-    nt.tagId = 123;
-    nt.clean();
-    expect(nt.validate()).toBe(false);
-});
-
-test('validate fails if tagId is 0', () => {
-    const nt = new NoteTag();
-    nt.noteId = 123;
-    expect(nt.validate()).toBe(false);
-});
-
-test('validate throws error if arg set to true', () => {
-    const nt = new NoteTag();
-    expect(() => nt.validate(true)).toThrowError();
-});
-
-test('validate fails if noteId = tagId', () => {
-    const nt = new NoteTag();
-    nt.noteId = 123;
-    nt.tagId = 123;
-    expect(nt.validate()).toBe(false);
-});
-
-test('validate succeeds if noteId & tagId are both positive, different values', () => {
-    const nt = new NoteTag();
-    nt.noteId = 123;
-    nt.tagId = 234;
-    expect(nt.validate()).toBe(true);
-});
-
-
-test('addAttr adds NoteAttr object to parent note', () => {
-    const note = new Note();
-    const tag = new Tag('hello').clean();
-    tag.id = 123;
-    const attr = new Attr().clean();
-    attr.id = 234;
-    const nt = note.addTag(tag);
-
-    nt.addAttr(attr);
-
-    expect(note.attrs.length).toBe(1);
-    expect(note.attrs[0].note).toBe(note);
-    expect(note.attrs[0].attr).toBe(attr);
-    expect(note.attrs[0].tag).toBe(tag);
-});
-
-test('addAttr throws error if note property not set', () => {
-    const nt = new NoteTag();
-    nt.noteId = 123;
-    nt.tag = new Tag('hello');
-    nt.tag.id = 234;
-    const attr = new Attr().clean();
-    attr.id = 345;
-    
-    expect(() => nt.addAttr(attr)).toThrowError();
-});
-
-test('attrs returns NoteAttr objects with matching tagId', () => {
-    const note = new Note();
-    const tag = new Tag('hello').clean();
-    tag.id = 123;
-    const attr1 = new Attr().clean();
-    attr1.id = 234;
-    const attr2 = new Attr().clean();
-    attr2.id = 345;
-    const nt = note.addTag(tag);
-    nt.addAttr(attr1);
-    note.addAttr(attr2);
-
-    expect(nt.attrs.length).toBe(1);
-    expect(nt.attrs[0].attr).toBe(attr1);
-});

package/src/models/NoteTag.ts

@@ -1,86 +0,0 @@
-'use strict';
-
-import Note from './Note';
-import ModelWithState from './ModelWithState';
-import Tag from './Tag';
-import Attr from './Attr';
-import NoteAttr from './NoteAttr';
-
-
-export default class NoteTag extends ModelWithState<NoteTag> {
-    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 _tagId: number = 0;
-    get tagId(): number { return this._tagId; }
-    set tagId(value: number) {
-        if (value !== this._tagId) {
-            this._tagId = value;
-            if (value !== this.tag?.id ?? 0)
-                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 ?? 0;
-    }
-
-
-    get attrs(): Array<NoteAttr> {
-        return this.note.attrs.filter(x => x.tagId == this.tagId);
-    }
-
-    addAttr(attr: Attr): NoteAttr {
-        if (!this.note)
-            throw new Error('Cannot call addAttr on NoteTag where note property has not been set');
-        const na = this.note.addAttr(attr);
-        na.tag = this.tag;
-        return na;
-    }
-
-
-    duplicate(): NoteTag {
-        const output = new NoteTag();
-        output.noteId = this.noteId;
-        output.tagId = this.tagId;
-        return output;
-    }
-
-
-    validate(throwError: boolean = false): boolean {
-        let output = null;
-
-        if (this.noteId <= 0 && !this.isNew)
-            output = 'NoteTag noteId must be greater than zero';
-        else if (this.tagId <= 0)
-            output = 'NoteTag tagId must be greater than zero';
-        else if (this.noteId == this.tagId)
-            output = 'NoteTag cannot link a note to its own tag';
-
-        if (throwError && output != null)
-            throw Error(output);
-        return output == null;
-    }
-}

package/src/models/Space.test.ts

@@ -1,53 +0,0 @@
-import { expect, test } from 'vitest';
-import Space from './Space';
-
-
-test('Gets initiated as new', () => {
-    const space = new Space();
-    expect(space.isNew).toBe(true);
-});
-
-
-test('Set name marks space as dirty if currently clean', () => {
-    const space = new Space().clean();
-    space.name = 'asdf';
-    expect(space.isDirty).toBe(true);
-});
-
-test('Set name doesnt change space state if new', () => {
-    const space = new Space().new();
-    space.name = 'asdf';
-    expect(space.isNew).toBe(true);
-});
-
-test('Set name doesnt change space state if value not different', () => {
-    const space = new Space().clean();
-    space.name = '';
-    expect(space.isClean).toBe(true);
-});
-
-
-test('Space can be initiated with name in constructor', () => {
-    const space = new Space('hello');
-    expect(space.name).toBe('hello');
-});
-
-test('can duplicate itself', () => {
-    const space = new Space('hello').clean();
-    const copy = space.duplicate();
-    expect(copy.id).toBe(space.id);
-    expect(copy.name).toBe(space.name);
-    expect(copy.state).toBe(space.state);
-});
-
-test('validate fails if not new and id <= 0', () => {
-    const model = new Space().clean();
-    model.id = 0;
-    expect(model.validate()).toBe(false);
-});
-
-test('validate throws error if arg set to true', () => {
-    const model = new Space().clean();
-    model.id = 0;
-    expect(() => model.validate(true)).toThrowError();
-});

package/src/models/Space.ts

@@ -1,46 +0,0 @@
-'use strict';
-
-import ModelWithState from './ModelWithState';
-
-
-export default class Space extends ModelWithState<Space> {
-    id: number = 0;
-
-    
-    private _name: string = '';
-    get name(): string { return this._name; }
-    set name(value: string) {
-        if (value !== this._name) {
-            this._name = value;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-
-    constructor(name: string = '') {
-        super();
-        this._name = name;
-    }
-
-
-    duplicate(): Space {
-        const output = new Space();
-        output.id = this.id;
-        output.name = this.name;
-        output.state = this.state;
-        return output;
-    }
-
-
-    validate(throwError: boolean = false): boolean {
-        let output = null;
-
-        if (!this.isNew && this.id <= 0)
-            output = 'Space id must be greater than zero if in non-new state.';
-
-        if (throwError && output != null)
-            throw Error(output);
-        return output == null;
-    }
-}

package/src/models/Tag.test.ts

@@ -1,71 +0,0 @@
-import { expect, test } from 'vitest';
-import Tag from './Tag';
-
-
-test('Gets initiated as new', () => {
-    const tag = new Tag();
-    expect(tag.isNew).toBe(true);
-});
-
-
-test('Set id marks tag as dirty if currently clean', () => {
-    const tag = new Tag().clean();
-    tag.id = 123;
-    expect(tag.isDirty).toBe(true);
-});
-
-test('Set id doesnt change tag state if new', () => {
-    const tag = new Tag().new();
-    tag.id = 123;
-    expect(tag.isNew).toBe(true);
-});
-
-test('Set id doesnt change tag state if value not different', () => {
-    const tag = new Tag().clean();
-    tag.id = 0;
-    expect(tag.isClean).toBe(true);
-});
-
-
-test('Set name marks tag as dirty if currently clean', () => {
-    const tag = new Tag().clean();
-    tag.name = 'asdf';
-    expect(tag.isDirty).toBe(true);
-});
-
-test('Set name doesnt change tag state if new', () => {
-    const tag = new Tag().new();
-    tag.name = 'asdf';
-    expect(tag.isNew).toBe(true);
-});
-
-test('Set name doesnt change tag state if value not different', () => {
-    const tag = new Tag().clean();
-    tag.name = '';
-    expect(tag.isClean).toBe(true);
-});
-
-test('Tag can be initiated with name in constructor', () => {
-    const tag = new Tag('hello');
-    expect(tag.name).toBe('hello');
-});
-
-test('can duplicate itself', () => {
-    const tag = new Tag('hello');
-    const copy = tag.duplicate();
-    expect(copy.id).toBe(tag.id);
-    expect(copy.name).toBe(tag.name);
-    expect(copy.state).toBe(tag.state);
-});
-
-test('validate fails if not new and id <= 0', () => {
-    const model = new Tag().clean();
-    model.id = 0;
-    expect(model.validate()).toBe(false);
-});
-
-test('validate throws error if arg set to true', () => {
-    const model = new Tag().clean();
-    model.id = 0;
-    expect(() => model.validate(true)).toThrowError();
-});

package/src/models/Tag.ts

@@ -1,54 +0,0 @@
-'use strict';
-
-import ModelWithState from './ModelWithState';
-
-
-export default class Tag extends ModelWithState<Tag> {
-    private _id: number = 0;
-    get id(): number { return this._id; }
-    set id(value: number) {
-        if (value !== this._id) {
-            this._id = value;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-    
-    private _name: string = '';
-    get name(): string { return this._name; }
-    set name(value: string) {
-        if (value !== this._name) {
-            this._name = value;
-            if (this.isClean)
-                this.dirty();
-        }
-    }
-
-
-    constructor(name: string = '') {
-        super();
-        this._name = name;
-    }
-
-
-    duplicate(): Tag {
-        const output = new Tag();
-        output.id = this.id;
-        output.name = this.name;
-        output.state = this.state;
-        return output;
-    }
-
-
-    validate(throwError: boolean = false): boolean {
-        let output = null;
-
-        if (!this.isNew && this.id <= 0)
-            output = 'Tag id must be greater than zero if in non-new state.';
-
-        if (throwError && output != null)
-            throw Error(output);
-        return output == null;
-    }
-}

package/src/services/HttpClient.test.ts

@@ -1,108 +0,0 @@
-import { expect, test } from 'vitest';
-import HttpClient from './HttpClient';
-import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
-import Space from '../models/Space';
-
-
-function mockAxiosResponse(status: number, data: any): AxiosResponse<any, any> {
-    const response = {
-        data,
-        status,
-        statusText: 'hello',
-        headers: null,
-        config: null
-    };
-    if (status < 200 || status >= 300) {
-        const error = new Error('Something went wrong');
-        error['response'] = response;
-        throw error;
-    }
-    return response;
-}
-
-async function mockAxios(config: AxiosRequestConfig<any>): Promise<AxiosResponse<any, any>> {
-    if (config.method == 'post' && config.url.endsWith('/login')) {
-        if (config.data.username == 'ValidUser' && config.data.password == 'ValidPassword')
-            return mockAxiosResponse(200, 'qwer.asdf.zxcv');
-        return mockAxiosResponse(401, null);
-    }
-    if (config.method == 'get' && config.url.endsWith('/spaces')) {
-        return mockAxiosResponse(200, [
-            new Space('Space 1'),
-            new Space('Space 2')
-        ]);
-    }
-    return mockAxiosResponse(404, null);
-}
-
-
-
-
-test('constructor takes api root url', () => {
-    const client = new HttpClient('https://www.test.com');
-
-    expect(client.url).toBe('https://www.test.com');
-});
-
-test('constructor throws error if url not provided', () => {
-    expect(() => new HttpClient(null)).toThrowError();
-});
-
-test('If no httpRequester method passed in, then defaults to using axios', () => {
-    const client = new HttpClient('abcd');
-    
-    expect(client['_httpRequester']).toBe(axios);
-});
-
-
-test('login asyncronously gets token from web service', async () => {
-    const client = new HttpClient('abcd', mockAxios);
-    const loginResult = await client.login('ValidUser', 'ValidPassword');
-
-    expect(loginResult.success).toBe(true);
-    expect(loginResult.error).toBeNull();
-    expect(loginResult.token).toBe('qwer.asdf.zxcv');
-});
-
-test('login fails if username and password are invalid', async () => {
-    const client = new HttpClient('abcd', mockAxios);
-    const loginResult = await client.login('InvalidUser', 'InvalidPassword');
-
-    expect(loginResult.success).toBe(false);
-    expect(loginResult.error).toBe('Invalid username & password.');
-    expect(loginResult.token).toBeNull();
-});
-
-test('login sets token on the client', async () => {
-    const client = new HttpClient('abcd', mockAxios);
-    await client.login('ValidUser', 'ValidPassword');
-
-    expect(client.token).toBe('qwer.asdf.zxcv');
-});
-
-test('Token can be manually set if already known', () => {
-    const client = new HttpClient('abcd', mockAxios);
-    client.token = 'qwer.asdf.zxcv';
-
-    expect(client.token).toBe('qwer.asdf.zxcv');
-});
-
-
-test('getSpaces makes async call to correct URL endpoint, returns space objects', async () => {
-    let request: AxiosRequestConfig<any> = null;
-    const client = new HttpClient('abcd', r => {
-        request = r;
-        return mockAxios(r);
-    });
-    client.token = 'qwer.asdf.zxcv';
-
-    const result = await client.getSpaces();
-
-    expect(request.method).toBe('get');
-    expect(request.url).toBe('abcd/spaces');
-    expect(request.data).toBeFalsy();
-    expect(request.headers.Authorization).toBe('Bearer qwer.asdf.zxcv');
-    expect(result.length).toBe(2);
-    expect(result[0].name).toBe('Space 1');
-    expect(result[1].name).toBe('Space 2');
-});