@tblabs/storage 5.8.2 → 5.9.0

package/Dataset.d.ts

@@ -13,9 +13,12 @@ export declare class Dataset<T extends object> implements IRepo<T> {
     private get DatasetPath();
     CanUserDo(action: keyof IStorageUserPrivileges): boolean;
     GetOne(id: string): Promise<T>;
+    Read(id: string, length?: number, offset?: number): Promise<string>;
     GetAll(): Promise<T[]>;
     GetAllIds(): Promise<string[]>;
     Add(id: string, item: T): Promise<void>;
+    Append(id: string, text: string): Promise<void>;
+    AppendLine(id: string, line: string): Promise<void>;
     Update(id: string, item: T): Promise<void>;
     Delete(id: string): Promise<void>;
     Drop(): Promise<void>;

package/Dataset.js

@@ -5,6 +5,8 @@ import { ListFilesQuery } from "./Messages/ListFilesQuery";
 import { GetFileQuery } from "./Messages/GetFileQuery";
 import { UpdateFileCommand } from "./Messages/UpdateFileCommand";
 import { ListFilesIdsQuery } from "./Messages/ListFilesIdsQuery";
+import { AppendCommand } from "./Messages/AppendCommand";
+import { ReadFileQuery } from "./Messages/ReadFileQuery";
 export class Dataset {
     _db;
     _converter;
@@ -46,6 +48,16 @@ export class Dataset {
         this._db.Log(`Fetched "${id}" from "${this.DatasetPath}".`);
         return item;
     }
+    async Read(id, length = 0, offset = 0) {
+        this._db.Log(`Reading "${id}" from "${this.DatasetPath}"...`);
+        const queryResult = await this._db.Send(new ReadFileQuery(this._db.DatabaseDir, this.dataset, id, length, offset));
+        if (!queryResult.IsSuccess) {
+            throw new Error("Failed to read: " + queryResult.ErrorMessage);
+        }
+        const content = queryResult.Result;
+        this._db.Log(`Read ${content.length} characters from "${id}" in "${this.DatasetPath}".`);
+        return content;
+    }
     async GetAll() {
         this._db.Log(`Fetching all from "${this.DatasetPath}"...`);
         const queryResult = await this._db.Send(new ListFilesQuery(this._db.DatabaseDir, this.dataset));
@@ -77,6 +89,18 @@ export class Dataset {
         this._db.Log(`"${id}" added to "${this.DatasetPath}".`);
     }
     ;
+    async Append(id, text) {
+        this._db.Log(`Appending ${text.length} characters to "${id}" in "${this.DatasetPath}"...`);
+        const result = await this._db.Send(new AppendCommand(this._db.DatabaseDir, this.dataset, id, text));
+        if (!result.IsSuccess) {
+            throw new Error("Failed to append: " + result.ErrorMessage);
+        }
+        this._db.Log(`${text.length} characters appended to "${id}" in "${this.DatasetPath}".`);
+    }
+    ;
+    async AppendLine(id, line) {
+        await this.Append(id, line + "\n");
+    }
     async Update(id, item) {
         this._db.Log(`Updating "${id}"...`);
         const rawItem = this._converter.ToRaw(item);

package/DatasetInfo.d.ts

@@ -0,0 +1,4 @@
+export interface DatasetInfo {
+    Name: string;
+    FilesCount: number;
+}

package/DatasetInfo.js

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

package/DummyConverter.d.ts

@@ -0,0 +1,5 @@
+import { IConverter } from "./IConverter";
+export declare class DummyConverter implements IConverter<any, any> {
+    FromRaw(raw: any): any;
+    ToRaw(item: any): any;
+}

package/DummyConverter.js

@@ -0,0 +1,8 @@
+export class DummyConverter {
+    FromRaw(raw) {
+        return raw;
+    }
+    ToRaw(item) {
+        return item;
+    }
+}

package/Messages/AppendCommand.d.ts

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

package/Messages/AppendCommand.js

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

package/Messages/ReadFileQuery.d.ts

@@ -0,0 +1,5 @@
+import { Message } from '../MessageBus/Message';
+import { dir } from '../Types/dir';
+export declare class ReadFileQuery extends Message {
+    constructor(Database: dir, Dataset: dir, FileId: string, Length?: number, Offset?: number);
+}

package/Messages/ReadFileQuery.js

@@ -0,0 +1,6 @@
+import { Message } from '../MessageBus/Message';
+export class ReadFileQuery extends Message {
+    constructor(Database, Dataset, FileId, Length = 0, Offset = 0) {
+        super("ReadFile", { Database, Dataset, FileId, Length, Offset });
+    }
+}

package/OnlineStorage.d.ts

@@ -8,6 +8,7 @@ import { IStorageUser } from "./IStorageUser";
 import { IConverter } from "./IConverter";
 import { IStorageUserPrivileges } from "./IStorageUserPrivileges";
 import { DatabaseInfo } from "./DatabaseInfo";
+import { DatasetInfo } from "./DatasetInfo";
 export declare class OnlineStorage {
     private server;
     private database;
@@ -23,7 +24,7 @@ export declare class OnlineStorage {
     constructor(server: url, database: dir, sender?: ISender, bus?: MessageBus);
     SetServer(server: url): this;
     SetDatabase(database: dir): this;
-    ListDatasets(): Promise<string[]>;
+    ListDatasets(): Promise<DatasetInfo[]>;
     ListUsers(): Promise<IStorageUser[]>;
     GetUser(userId: string): Promise<IStorageUser>;
     AddUser(user: IStorageUser): Promise<void>;

package/index.d.ts

@@ -4,6 +4,7 @@ export * from "./IEntitiesSet";
 export * from "./IStorageUser";
 export * from "./IConverter";
 export * from "./Converter";
+export * from "./DummyConverter";
 export * from "./IRepo";
 export * from "./IRepos";
 export * from "./Dataset";

package/index.js

@@ -4,6 +4,7 @@ export * from "./IEntitiesSet";
 export * from "./IStorageUser";
 export * from "./IConverter";
 export * from "./Converter";
+export * from "./DummyConverter";
 export * from "./IRepo";
 export * from "./IRepos";
 export * from "./Dataset";

package/package.json

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