@tblabs/storage 5.13.1 → 5.14.0

package/Datasets/DatasetBase.d.ts

@@ -2,6 +2,7 @@ import { IStorageUserPrivileges } from "../Models/IStorageUserPrivileges";
 import { DatasetType } from "../Services/DatasetType";
 import { OnlineStorage } from "../Services/OnlineStorage";
 import { dir } from "../Types/dir";
+import { DatasetMetadata } from "../Models/DatasetMetadata";
 export declare abstract class DatasetBase {
     protected _db: OnlineStorage;
     protected dataset: dir;
@@ -13,6 +14,7 @@ export declare abstract class DatasetBase {
     get Name(): string;
     get Database(): OnlineStorage;
     protected get DatasetPath(): string;
+    GetMetadata(): Promise<DatasetMetadata>;
     CanUserDo(action: keyof IStorageUserPrivileges): boolean;
     protected Log(message: string): void;
 }

package/Datasets/DatasetBase.js

@@ -1,3 +1,4 @@
+import { GetMetadataQuery } from "../Messages/GetMetadataQuery";
 export class DatasetBase {
     _db;
     dataset;
@@ -14,6 +15,13 @@ export class DatasetBase {
     get DatasetPath() {
         return this._db.DatabaseDir + "/Datasets/" + this.dataset;
     }
+    async GetMetadata() {
+        const response = await this._db.Send(new GetMetadataQuery(this._db.DatabaseDir, this.dataset));
+        if (!response.IsSuccess) {
+            throw new Error("Failed to get metadata: " + response.ErrorMessage);
+        }
+        return response.Result;
+    }
     CanUserDo(action) {
         if (!this._db.User.Privileges) {
             return false;

package/Datasets/Picture/PicturesDataset.js

@@ -58,6 +58,7 @@ export class PicturesDataset extends DatasetBase {
             formData.append('database', this._db.DatabaseDir);
             formData.append('dataset', this.dataset);
             formData.append('config', JSON.stringify(this.picsConfig));
+            formData.append('userId', this._db.User.Id);
             let serverUrl = this._db.Server;
             if (serverUrl.endsWith("/")) // Because for local env we use ".../src/" but for prod ".../v5"
              {

package/Datasets/Text/RawTextDataset.js

@@ -18,6 +18,9 @@ export class RawTextDataset extends DatasetBase {
     }
     async Read(id, offset = 0, limit = 0) {
         this.Log(`Reading "${id}" from "${this.DatasetPath}"...`);
+        if (limit < 0) {
+            throw new Error("Limit cannot be negative number. 0 = no limit.");
+        }
         const queryResult = await this._db.Send(new ReadFileQuery(this._db.DatabaseDir, this.dataset, id, offset, limit));
         if (!queryResult.IsSuccess) {
             throw new Error("Failed to read: " + queryResult.ErrorMessage);

package/Messages/GetMetadataQuery.d.ts

@@ -0,0 +1,5 @@
+import { Message } from '../MessageBus/Message';
+import { dir } from '../Types/dir';
+export declare class GetMetadataQuery extends Message {
+    constructor(Database: dir, Dataset: dir);
+}

package/Messages/GetMetadataQuery.js

@@ -0,0 +1,6 @@
+import { Message } from '../MessageBus/Message';
+export class GetMetadataQuery extends Message {
+    constructor(Database, Dataset) {
+        super("GetMetadata", { Database, Dataset });
+    }
+}

package/Models/DatasetMetadata.d.ts

@@ -0,0 +1,5 @@
+export interface DatasetMetadata {
+    Type: string;
+    CreatedBy: string;
+    CreatedAt: Date;
+}

package/Models/DatasetMetadata.js

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

package/Models/IStorageUserPrivileges.d.ts

@@ -54,6 +54,7 @@ export interface IStorageUserPrivileges {
     RemoveDataset: {
         Datasets: IEntitiesSet;
     };
+    GetMetadata: boolean;
     ListDatasets: boolean;
     ListUsers: boolean;
     GetLogs: boolean;

package/Services/OnlineStorage.d.ts

@@ -18,6 +18,7 @@ import { PicsConfig } from "../Datasets/Picture/PicsConfig";
 export declare class OnlineStorage {
     private server;
     private database;
+    private sender;
     private ANONYMOUS_USER;
     private user;
     private logEnabled;
@@ -27,6 +28,7 @@ export declare class OnlineStorage {
     private userLocalStorageKey;
     get Server(): string;
     get DatabaseDir(): dir;
+    get User(): IStorageUser;
     constructor(server: url, database: dir, sender?: ISender, bus?: MessageBus);
     SetServer(server: url): this;
     SetDatabase(database: dir): this;
@@ -41,7 +43,6 @@ export declare class OnlineStorage {
     GetPicturesDataset(datasetName: string, picsConfig?: PicsConfig): PicturesDataset;
     private IsBrowserEnvironment;
     private LoadUserFromLocalStorage;
-    get User(): IStorageUser;
     Login(password: string, login?: string): Promise<IStorageUser>;
     private SaveUserInLocalStorage;
     OnUserChange(handler: (user: IStorageUser, isAuthorized: boolean, appStart: boolean) => void): this;

package/Services/OnlineStorage.js

@@ -22,6 +22,7 @@ import { PicturesDataset } from "../Datasets/Picture/PicturesDataset";
 export class OnlineStorage {
     server;
     database;
+    sender;
     ANONYMOUS_USER = { Id: "Anonymous" };
     user = this.ANONYMOUS_USER;
     logEnabled = false;
@@ -35,9 +36,13 @@ export class OnlineStorage {
     get DatabaseDir() {
         return this.database;
     }
+    get User() {
+        return this.user;
+    }
     constructor(server, database, sender = this.ANONYMOUS_USER, bus) {
         this.server = server;
         this.database = database;
+        this.sender = sender;
         this._bus = bus || new MessageBus(server, sender);
         this.userLocalStorageKey = this.USER_LOCAL_STORAGE_KEY_PREFIX + this.database;
         if (this.LoadUserFromLocalStorage()) {
@@ -127,9 +132,6 @@ export class OnlineStorage {
         }
         return false;
     }
-    get User() {
-        return this.user;
-    }
     async Login(password, login) {
         const result = await this._bus.SendMessage(new LoginUserQuery(this.DatabaseDir, password, login));
         if (!result.IsSuccess) {

package/index.d.ts

@@ -3,6 +3,7 @@ export * from "./Models/IStorageUserPrivileges";
 export * from "./Models/IEntitiesSet";
 export * from "./Models/IStorageUser";
 export * from "./Models/DatabaseInfo";
+export * from "./Models/DatasetMetadata";
 export * from "./Converters/IConverter";
 export * from "./Converters/Converter";
 export * from "./Converters/DummyConverter";

package/index.js

@@ -3,6 +3,7 @@ export * from "./Models/IStorageUserPrivileges";
 export * from "./Models/IEntitiesSet";
 export * from "./Models/IStorageUser";
 export * from "./Models/DatabaseInfo";
+export * from "./Models/DatasetMetadata";
 export * from "./Converters/IConverter";
 export * from "./Converters/Converter";
 export * from "./Converters/DummyConverter";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tblabs/storage",
-  "version": "5.13.1",
+  "version": "5.14.0",
   "description": "online storage module with auth",
   "license": "beerware",
   "main": "index.js",