@tblabs/storage 5.13.2 → 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/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/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.2",
+  "version": "5.14.0",
   "description": "online storage module with auth",
   "license": "beerware",
   "main": "index.js",