notu 0.2.2 → 0.2.3

package/dist/index.d.ts

@@ -0,0 +1,238 @@
+import { AxiosRequestConfig } from 'axios';
+import { AxiosResponse } from 'axios';
+
+declare class Attr_2 extends ModelWithState<Attr_2> {
+    id: number;
+    private _name;
+    get name(): string;
+    set name(value: string);
+    private _type;
+    get type(): AttrType;
+    set type(value: AttrType);
+    get isText(): boolean;
+    get isNumber(): boolean;
+    get isBoolean(): boolean;
+    get isDate(): boolean;
+    asText(): Attr_2;
+    asNumber(): Attr_2;
+    asBoolean(): Attr_2;
+    asDate(): Attr_2;
+    private _spaceId;
+    get spaceId(): number;
+    set spaceId(value: number);
+    private _space;
+    get space(): Space;
+    set space(value: Space);
+    duplicate(): Attr_2;
+    validate(throwError?: boolean): boolean;
+    get defaultValue(): any;
+}
+export { Attr_2 as Attr }
+
+declare const ATTR_TYPE: {
+    TEXT: string;
+    NUMBER: string;
+    BOOLEAN: string;
+    DATE: string;
+};
+
+declare type AttrType = keyof typeof ATTR_TYPE;
+
+export declare class Environment {
+    private _client;
+    get client(): NotuClient;
+    private _spaces;
+    get spaces(): Array<Space>;
+    constructor(client: NotuClient);
+    loadSpaces(): Promise<Array<Space>>;
+    saveSpace(space: Space): Promise<Space>;
+    getNotes(query: string, spaceId: number): Promise<Array<Note>>;
+    getNoteCount(query: string, spaceId: number): Promise<number>;
+    saveNote(note: Note): Promise<Note>;
+    saveNotes(notes: Array<Note>): Promise<Array<Note>>;
+    customJob(name: string, data: any): Promise<any>;
+}
+
+export declare class HttpClient {
+    private _url;
+    get url(): string;
+    private _token;
+    get token(): string;
+    set token(value: string);
+    private _httpRequester;
+    constructor(url: string, httpRequester?: (config: AxiosRequestConfig<any>) => Promise<AxiosResponse<any, any>>);
+    login(username: string, password: string): Promise<NotuLoginResult>;
+    getSpaces(): Promise<Array<Space>>;
+    saveSpace(space: Space): Promise<Space>;
+    getNotes(query: string, spaceId: number): Promise<Array<Note>>;
+    getNoteCount(query: string, spaceId: number): Promise<number>;
+    saveNotes(notes: Array<Note>): Promise<Array<Note>>;
+    customJob(name: string, data: any): Promise<any>;
+}
+
+declare const MODEL_STATE: {
+    NEW: string;
+    CLEAN: string;
+    DIRTY: string;
+    DELETED: string;
+};
+
+declare type ModelState = keyof typeof MODEL_STATE;
+
+declare class ModelWithState<T extends ModelWithState<T>> {
+    state: ModelState;
+    new(): T;
+    clean(): T;
+    dirty(): T;
+    delete(): T;
+    get isNew(): boolean;
+    get isClean(): boolean;
+    get isDirty(): boolean;
+    get isDeleted(): boolean;
+    validate(throwError?: boolean): boolean;
+}
+
+export declare class Note extends ModelWithState<Note> {
+    id: number;
+    private _date;
+    get date(): Date;
+    set date(value: Date);
+    private _text;
+    get text(): string;
+    set text(value: string);
+    private _archived;
+    get archived(): boolean;
+    set archived(value: boolean);
+    private _spaceId;
+    get spaceId(): number;
+    set spaceId(value: number);
+    private _space;
+    get space(): Space;
+    set space(value: Space);
+    private _ownTag;
+    get ownTag(): Tag;
+    setOwnTag(tag: string | Tag): Note;
+    removeOwnTag(): Note;
+    private _tags;
+    get tags(): Array<NoteTag>;
+    addTag(tag: Tag): NoteTag;
+    removeTag(tag: Tag): Note;
+    private _attrs;
+    get attrs(): Array<NoteAttr>;
+    addAttr(attr: Attr_2): NoteAttr;
+    removeAttr(attr: Attr_2): Note;
+    duplicate(): Note;
+    validate(throwError?: boolean): boolean;
+}
+
+export declare class NoteAttr extends ModelWithState<NoteAttr> {
+    private _noteId;
+    get noteId(): number;
+    set noteId(value: number);
+    private _note;
+    get note(): Note;
+    set note(value: Note);
+    private _attrId;
+    get attrId(): number;
+    set attrId(value: number);
+    private _attr;
+    get attr(): Attr_2;
+    set attr(newAttr: Attr_2);
+    private _value;
+    get value(): any;
+    set value(newVal: any);
+    private _tagId;
+    get tagId(): number;
+    set tagId(value: number);
+    private _tag;
+    get tag(): Tag;
+    set tag(value: Tag);
+    duplicate(): NoteAttr;
+    validate(throwError?: boolean): boolean;
+}
+
+export declare class NoteTag extends ModelWithState<NoteTag> {
+    private _noteId;
+    get noteId(): number;
+    set noteId(value: number);
+    private _note;
+    get note(): Note;
+    set note(value: Note);
+    private _tagId;
+    get tagId(): number;
+    set tagId(value: number);
+    private _tag;
+    get tag(): Tag;
+    set tag(value: Tag);
+    get attrs(): Array<NoteAttr>;
+    addAttr(attr: Attr_2): NoteAttr;
+    duplicate(): NoteTag;
+    validate(throwError?: boolean): boolean;
+}
+
+declare interface NotuClient {
+    login(username: string, password: string): Promise<NotuLoginResult>;
+    getSpaces(): Promise<Array<Space>>;
+    saveSpace(space: Space): Promise<Space>;
+    getNotes(query: string, spaceId: number): Promise<Array<Note>>;
+    getNoteCount(query: string, spaceId: number): Promise<number>;
+    saveNotes(notes: Array<Note>): Promise<Array<Note>>;
+    customJob(name: string, data: any): Promise<any>;
+}
+
+declare interface NotuLoginResult {
+    success: boolean;
+    error: string;
+    token: string;
+}
+
+declare class ParsedAttr {
+    space: string;
+    name: string;
+    exists: boolean;
+    tagNameFilters: Array<ParsedTag>;
+}
+
+declare class ParsedQuery {
+    where: string;
+    order: string;
+    tags: Array<ParsedTag>;
+    attrs: Array<ParsedAttr>;
+}
+
+declare class ParsedTag {
+    space: string;
+    name: string;
+    searchDepth: number;
+    strictSearchDepth: boolean;
+    includeOwner: boolean;
+}
+
+export declare function parseQuery(query: string): ParsedQuery;
+
+export declare class Space extends ModelWithState<Space> {
+    id: number;
+    private _name;
+    get name(): string;
+    set name(value: string);
+    constructor(name?: string);
+    duplicate(): Space;
+    validate(throwError?: boolean): boolean;
+}
+
+export declare class Tag extends ModelWithState<Tag> {
+    private _id;
+    get id(): number;
+    set id(value: number);
+    private _name;
+    get name(): string;
+    set name(value: string);
+    private _color;
+    get color(): string;
+    set color(value: string);
+    constructor(name?: string);
+    duplicate(): Tag;
+    validate(throwError?: boolean): boolean;
+}
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notu",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "type": "module",
   "main": "dist/notu.js",
   "unpkg": "dist/notu.js",
@@ -21,6 +21,7 @@
   "devDependencies": {
     "typescript": "^5.0.2",
     "vite": "^4.4.5",
+    "vite-plugin-dts": "^3.6.3",
     "vitest": "^0.34.4"
   },
   "dependencies": {