@tblabs/storage 5.0.1 → 5.2.0

package/Dataset.js

@@ -24,7 +24,7 @@ export class Dataset {
         this._db.Log(`Fetching "${id}"...`);
         const queryResult = await this._db.Send(new GetQuery(this._db.DatabaseDir, this.dataset, id));
         if (!queryResult.IsSuccess) {
-            throw new Error(`Could not fetch "${id}" from "${this.DatasetPath}": ${queryResult.ErrorMessage}`);
+            throw new Error(`Could not fetch file: ${queryResult.ErrorMessage}`);
         }
         const rawItem = queryResult.Result;
         const item = this._converter.FromRaw(rawItem);
@@ -35,7 +35,7 @@ export class Dataset {
         this._db.Log(`Searching for "${id}"...`);
         const queryResult = await this._db.Send(new FindQuery(id, this._db.DatabaseDir));
         if (!queryResult.IsSuccess) {
-            throw new Error(`Could not find "${id}" in "${this.DatasetPath}": ${queryResult.ErrorMessage}`);
+            throw new Error(`Could not find file: ${queryResult.ErrorMessage}`);
         }
         const rawItem = queryResult.Result;
         const item = this._converter.FromRaw(rawItem);
@@ -46,7 +46,7 @@ export class Dataset {
         this._db.Log(`Fetching all from "${this.DatasetPath}"...`);
         const queryResult = await this._db.Send(new ListQuery(this._db.DatabaseDir, this.dataset));
         if (!queryResult.IsSuccess) {
-            throw new Error(`Could not fetch items from "${this.DatasetPath}": ${queryResult.ErrorMessage}`);
+            throw new Error(`Could not fetch items: ${queryResult.ErrorMessage}`);
         }
         const rawItems = queryResult.Result;
         const items = rawItems.map((raw) => this._converter.FromRaw(raw));
@@ -70,7 +70,7 @@ export class Dataset {
         this._db.Log(`Adding "${id}" to "${this.DatasetPath}"...`);
         const result = await this._db.Send(new AddCommand(this._db.DatabaseDir, this.dataset, id, item));
         if (!result.IsSuccess) {
-            throw new Error(`Could not add "${id}" to "${this.DatasetPath}": ${result.ErrorMessage}`);
+            throw new Error(`Could not add file: ${result.ErrorMessage}`);
         }
         this._db.Log(`"${id}" added to "${this.DatasetPath}".`);
     }
@@ -79,7 +79,7 @@ export class Dataset {
         this._db.Log(`Updating "${id}"...`);
         const result = await this._db.Send(new UpdateCommand(this._db.DatabaseDir, this.dataset, id, item));
         if (!result.IsSuccess) {
-            throw new Error(`Could not update "${id}" in "${this.DatasetPath}": ${result.ErrorMessage}`);
+            throw new Error(`Could not update file: ${result.ErrorMessage}`);
         }
         this._db.Log(`"${id}" updated in "${this.DatasetPath}".`);
     }
@@ -88,7 +88,7 @@ export class Dataset {
         this._db.Log(`Deleting "${id}" from "${this.DatasetPath}"...`);
         const result = await this._db.Send(new DeleteCommand(this._db.DatabaseDir, this.dataset, id));
         if (!result.IsSuccess) {
-            throw new Error(`Could not delete "${id}" from "${this.DatasetPath}": ${result.ErrorMessage}`);
+            throw new Error(`Could not delete file: ${result.ErrorMessage}`);
         }
         this._db.Log(`Deleted "${id}" from "${this.DatasetPath}".`);
     }
@@ -96,7 +96,7 @@ export class Dataset {
         this._db.Log(`Dropping "${this.DatasetPath}"...`);
         const result = await this._db.Send(new DropCommand(this._db.DatabaseDir, this.dataset));
         if (!result.IsSuccess) {
-            throw new Error(`Could not drop "${this.DatasetPath}": ${result.ErrorMessage}`);
+            throw new Error(`Could not drop dataset: ${result.ErrorMessage}`);
         }
         this._db.Log(`"${this.DatasetPath}" dropped.`);
     }

package/IStorageUser.d.ts

@@ -0,0 +1,50 @@
+import { ISender } from "./MessageBus/ISender";
+export type IEntitiesSet = string[] | "all" | "none";
+export type ICommandPrivilege = {
+    Datasets?: IEntitiesSet;
+    Files?: IEntitiesSet;
+};
+export interface IStorageUserPrivileges {
+    Add: {
+        Datasets: IEntitiesSet;
+    };
+    Update: {
+        Files: IEntitiesSet;
+    };
+    Delete: {
+        Files: IEntitiesSet;
+    };
+    List: {
+        Datasets: IEntitiesSet;
+    };
+    Get: {
+        Files: IEntitiesSet;
+    };
+    Drop: {
+        Datasets: IEntitiesSet;
+    };
+    Move: {
+        Datasets: IEntitiesSet;
+        Files: IEntitiesSet;
+    };
+    Create: {
+        Datasets: IEntitiesSet;
+    };
+    Exists: {
+        Datasets: IEntitiesSet;
+    };
+    Remove: {
+        Datasets: IEntitiesSet;
+    };
+    Register: boolean;
+}
+export interface IStorageUser extends ISender {
+    Id: string;
+    Database: string;
+    Name: string;
+    Role: string;
+    Icon: string;
+    Password: string;
+    Privileges: IStorageUserPrivileges;
+    Tags: string[];
+}

package/IStorageUser.js

@@ -0,0 +1,2 @@
+;
+export {};

package/Messages/LoginQuery.d.ts

@@ -0,0 +1,5 @@
+import { Message } from "../MessageBus/Message";
+import { dir } from "../Types/dir";
+export declare class LoginQuery extends Message {
+    constructor(Database: dir, Password: string);
+}

package/Messages/LoginQuery.js

@@ -0,0 +1,6 @@
+import { Message } from "../MessageBus/Message";
+export class LoginQuery extends Message {
+    constructor(Database, Password) {
+        super("Login", { Database, Password });
+    }
+}

package/Messages/RegisterCommand.d.ts

@@ -0,0 +1,6 @@
+import { IStorageUserPrivileges } from "../IStorageUser";
+import { Message } from "../MessageBus/Message";
+import { dir } from "../Types/dir";
+export declare class RegisterCommand extends Message {
+    constructor(Database: dir, Id: string, Role: string, Name: string, Password: string, Privileges: IStorageUserPrivileges, Icon?: string, Tags?: string[]);
+}

package/Messages/RegisterCommand.js

@@ -0,0 +1,6 @@
+import { Message } from "../MessageBus/Message";
+export class RegisterCommand extends Message {
+    constructor(Database, Id, Role, Name, Password, Privileges, Icon, Tags) {
+        super("Register", { Database, Id, Role, Icon, Name, Password, Privileges, Tags });
+    }
+}

package/OnlineStorage.d.ts

@@ -3,68 +3,28 @@ import { IMessage } from "./MessageBus/IMessage";
 import { ISender } from "./MessageBus/ISender";
 import { MessageBus } from "./MessageBus/MessageBus";
 import { MessageBusResponse } from "./MessageBus/MessageBusResponse";
-import { Message } from "./MessageBus/Message";
 import { Dataset } from "./Dataset";
-export type IEntitiesSet = string[] | "all" | "none";
-export interface IUser {
-    Id: string;
-    Name: string;
-    Database: string;
-    Privileges: {
-        Add: {
-            Datasets: IEntitiesSet;
-        };
-        Update: {
-            Datasets: IEntitiesSet;
-            Files: IEntitiesSet;
-        };
-        Delete: {
-            Datasets: IEntitiesSet;
-            Files: IEntitiesSet;
-        };
-        List: {
-            Datasets: IEntitiesSet;
-        };
-        Get: {
-            Files: IEntitiesSet;
-        };
-        Drop: {
-            Datasets: IEntitiesSet;
-        };
-        Move: {
-            Datasets: IEntitiesSet;
-            Files: IEntitiesSet;
-        };
-        Backup: {
-            Datasets: IEntitiesSet;
-        };
-        Find: {
-            Files: IEntitiesSet;
-        };
-        Create: {
-            Datasets: IEntitiesSet;
-        };
-        Exists: {
-            Datasets: IEntitiesSet;
-        };
-        Remove: {
-            Datasets: IEntitiesSet;
-        };
-    };
-}
-export declare class AuthQuery extends Message {
-    constructor(Database: dir, Password: string);
-}
+import { IStorageUser, IStorageUserPrivileges } from "./IStorageUser";
 export declare class OnlineStorage {
     private database;
+    private ANONYMOUS_USER;
+    private user;
     private logEnabled;
     private readonly _bus;
+    private onUserChange;
+    private readonly USER_LOCAL_STORAGE_KEY;
     get DatabaseDir(): dir;
     constructor(server: url, database: dir, sender?: ISender, bus?: MessageBus);
-    Login(password: string): Promise<IUser>;
+    private IsBrowserEnvironment;
+    private LoadUserFromLocalStorage;
+    get User(): IStorageUser;
+    Login(password: string): Promise<IStorageUser>;
+    private SaveUserInLocalStorage;
+    OnUserChange(handler: (user: IStorageUser) => void): this;
+    Register(id: string, role: string, name: string, password: string, privileges: IStorageUserPrivileges, icon?: string, tags?: string[]): Promise<IStorageUser>;
     Logout(): this;
-    IsAuthorized(): boolean;
-    User(access: ISender): this;
+    get IsAuthorized(): boolean;
+    SetUser(sender: ISender): this;
     EnableLog(): this;
     DisableLog(): this;
     Log(...message: any[]): void;

package/OnlineStorage.js

@@ -1,41 +1,78 @@
 import { MessageBus } from "./MessageBus/MessageBus";
 import { CreateCommand, ExistsCommand, RemoveCommand } from "./Messages/AddDirCommand";
-import { Message } from "./MessageBus/Message";
 import { MoveCommand } from "./Messages/MoveCommand";
-export class AuthQuery extends Message {
-    constructor(Database, Password) {
-        super("LoginUser", { Database, Password });
-    }
-}
+import { LoginQuery } from "./Messages/LoginQuery";
+import { RegisterCommand } from "./Messages/RegisterCommand";
 export class OnlineStorage {
     database;
+    ANONYMOUS_USER = { Id: "Anonymous" };
+    user = this.ANONYMOUS_USER;
     logEnabled = false;
     _bus;
+    onUserChange = [];
+    USER_LOCAL_STORAGE_KEY;
     get DatabaseDir() {
         return this.database;
     }
-    constructor(server, database, sender = { Id: "Anonymous" }, bus) {
+    constructor(server, database, sender = this.ANONYMOUS_USER, bus) {
         this.database = database;
         this._bus = bus || new MessageBus(server, sender);
+        this.USER_LOCAL_STORAGE_KEY = "OnlineStorage:User:" + this.database;
+        this.LoadUserFromLocalStorage();
+    }
+    IsBrowserEnvironment() {
+        return typeof window !== "undefined" && typeof window.localStorage !== "undefined";
+    }
+    LoadUserFromLocalStorage() {
+        if (this.IsBrowserEnvironment()) {
+            const user = window.localStorage.getItem(this.USER_LOCAL_STORAGE_KEY);
+            if (user) {
+                this.user = JSON.parse(user);
+                this.SetUser(this.user || this.ANONYMOUS_USER);
+            }
+        }
+    }
+    get User() {
+        return this.user;
     }
     async Login(password) {
-        const result = await this._bus.SendMessage(new AuthQuery(this.DatabaseDir, password));
+        const result = await this._bus.SendMessage(new LoginQuery(this.DatabaseDir, password));
         if (!result.IsSuccess) {
             throw new Error(`Could not login: ${result.ErrorMessage}`);
         }
+        this.user = result.Result;
+        this.SetUser(this.user || this.ANONYMOUS_USER);
+        this.SaveUserInLocalStorage();
+        this.onUserChange.forEach(handler => handler(this.user));
+        return this.user;
+    }
+    SaveUserInLocalStorage() {
+        if (this.IsBrowserEnvironment()) {
+            window.localStorage.setItem(this.USER_LOCAL_STORAGE_KEY, JSON.stringify(this.user));
+        }
+    }
+    OnUserChange(handler) {
+        this.onUserChange.push(handler);
+        return this;
+    }
+    async Register(id, role, name, password, privileges, icon, tags) {
+        const result = await this._bus.SendMessage(new RegisterCommand(this.DatabaseDir, id, role, name, password, privileges, icon, tags));
+        if (!result.IsSuccess) {
+            throw new Error(`Could not register: ${result.ErrorMessage}`);
+        }
         const user = result.Result;
-        this.User({ Id: user?.Id ?? "Anonymous" });
         return user;
     }
     Logout() {
-        this.User({ Id: "Anonymous" });
+        this.SetUser(this.ANONYMOUS_USER);
+        this.onUserChange.forEach(handler => handler(this.ANONYMOUS_USER));
         return this;
     }
-    IsAuthorized() {
-        return this._bus.Sender?.Id !== "Anonymous";
+    get IsAuthorized() {
+        return this.user.Id !== this.ANONYMOUS_USER.Id;
     }
-    User(access) {
-        this._bus.SetSender(access);
+    SetUser(sender) {
+        this._bus.SetSender(sender);
         return this;
     }
     EnableLog() {
@@ -61,7 +98,7 @@ export class OnlineStorage {
         this.Log(`Creating dataset "${datasetName}"...`);
         const result = await this._bus.SendMessage(new CreateCommand(this.DatabaseDir, datasetName));
         if (!result.IsSuccess) {
-            throw new Error(`Could not add dataset "${datasetName}": ${result.ErrorMessage}`);
+            throw new Error(`Could not add dataset: ${result.ErrorMessage}`);
         }
         this.Log(`Dataset "${datasetName}" created.`);
     }
@@ -69,7 +106,7 @@ export class OnlineStorage {
         this.Log(`Checking if dataset "${datasetName}" exists...`);
         const result = await this._bus.SendMessage(new ExistsCommand(this.DatabaseDir, datasetName));
         if (!result.IsSuccess) {
-            throw new Error(`Could not check if dataset "${datasetName}" exists: ${result.ErrorMessage}`);
+            throw new Error(`Could not check if dataset exists: ${result.ErrorMessage}`);
         }
         this.Log(`Dataset "${datasetName}" ${result.Result ? "exists" : "does not exist"}.`);
         return result.Result;
@@ -78,7 +115,7 @@ export class OnlineStorage {
         this.Log(`Removing dataset "${datasetName}"...`);
         const result = await this._bus.SendMessage(new RemoveCommand(this.DatabaseDir, datasetName));
         if (!result.IsSuccess) {
-            throw new Error(`Could not remove dataset "${datasetName}": ${result.ErrorMessage}`);
+            throw new Error(`Could not remove dataset: ${result.ErrorMessage}`);
         }
         this.Log(`Dataset "${datasetName}" removed.`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tblabs/storage",
-  "version": "5.0.1",
+  "version": "5.2.0",
   "description": "online storage module with auth",
   "license": "beerware",
   "main": "index.js",
@@ -9,7 +9,7 @@
     "pack": "cd ./bin && npm pack",
     "clean": "rm ./bin -rf && rm *.tgz -rf",
     "build": "npm run clean && tsc ./src/index.ts --declaration --outDir ./bin && cp ./package.json ./bin/package.json",
-    "publish:npm": "npm run build && npm login && npm run pack && cd ./bin && npm publish --access public"
+    "publish:npm": "npm run build && npm run pack && cd ./bin && npm publish --access public"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",