@tblabs/storage 5.10.0 → 5.11.0

package/IRepo.d.ts

@@ -1,7 +1,7 @@
 import { IRepoBase } from "./IRepoBase";
 export interface IRepo<T> extends IRepoBase {
     Add(id: string, item: T): Promise<void>;
-    GetOne(id: string): Promise<T | null>;
+    GetOne(id: string): Promise<T>;
     GetAll(): Promise<T[]>;
     GetAllIds(): Promise<string[]>;
     Update(id: string, item: T): Promise<void>;

package/JsonTextConverter.d.ts

@@ -0,0 +1,5 @@
+import { TextConverter } from "./TextConverter";
+export declare class JsonTextConverter<T> implements TextConverter<T> {
+    ToLine(entry: T): string;
+    ToEntry(line: string): T;
+}

package/JsonTextConverter.js

@@ -0,0 +1,8 @@
+export class JsonTextConverter {
+    ToLine(entry) {
+        return JSON.stringify(entry);
+    }
+    ToEntry(line) {
+        return JSON.parse(line);
+    }
+}

package/OnlineStorage.d.ts

@@ -9,7 +9,7 @@ import { IConverter } from "./IConverter";
 import { IStorageUserPrivileges } from "./IStorageUserPrivileges";
 import { DatabaseInfo } from "./DatabaseInfo";
 import { DatasetInfo } from "./DatasetInfo";
-import { TextDataset } from "./TextDataset";
+import { RawTextDataset } from "./RawTextDataset";
 export declare class OnlineStorage {
     private server;
     private database;
@@ -32,7 +32,7 @@ export declare class OnlineStorage {
     UpdateUser(user: IStorageUser): Promise<void>;
     DeleteUser(user: IStorageUser): Promise<void>;
     GetDataset<T extends object>(datasetName: string, converter: IConverter<any, T>): Dataset<T>;
-    GetTextDataset(datasetName: string): TextDataset;
+    GetTextDataset(datasetName: string): RawTextDataset;
     private IsBrowserEnvironment;
     private LoadUserFromLocalStorage;
     get User(): IStorageUser;

package/OnlineStorage.js

@@ -17,7 +17,7 @@ import { ListDatabasesQuery } from "./ListDatabasesQuery";
 import { CreateDatabaseCommand } from "./CreateDatabaseCommand";
 import { ListDatasetsQuery } from "./Messages/ListDatabasesQuery";
 import { DeleteDatabaseCommand } from "./DeleteDatabaseCommand";
-import { TextDataset } from "./TextDataset";
+import { RawTextDataset } from "./RawTextDataset";
 export class OnlineStorage {
     server;
     database;
@@ -107,7 +107,7 @@ export class OnlineStorage {
         return new Dataset(this, converter, datasetName);
     }
     GetTextDataset(datasetName) {
-        return new TextDataset(this, datasetName);
+        return new RawTextDataset(this, datasetName);
     }
     IsBrowserEnvironment() {
         return typeof window !== "undefined" && typeof window.localStorage !== "undefined";

package/RawTextDataset.d.ts

@@ -0,0 +1,16 @@
+import { DatasetBase } from "./DatasetBase";
+import { ITextRepo } from "./ITextRepo";
+import { OnlineStorage } from "./OnlineStorage";
+import { dir } from "./Types/dir";
+export declare class RawTextDataset extends DatasetBase implements ITextRepo {
+    protected _db: OnlineStorage;
+    protected dataset: dir;
+    constructor(_db: OnlineStorage, dataset: dir);
+    Read(id: string, offset?: number, limit?: number): Promise<string[]>;
+    GetAllIds(): Promise<string[]>;
+    Create(id: string): Promise<void>;
+    AppendText(id: string, text: string): Promise<void>;
+    AppendLine(id: string, line: string): Promise<void>;
+    Delete(id: string): Promise<void>;
+    Drop(): Promise<void>;
+}

package/RawTextDataset.js

@@ -0,0 +1,73 @@
+import { DatasetBase } from "./DatasetBase";
+import { AppendCommand } from "./Messages/AppendCommand";
+import { CreateFileCommand } from "./Messages/CreateFileCommand";
+import { DeleteFileCommand } from "./Messages/DeleteFileCommand";
+import { DropDatasetCommand } from "./Messages/DropDatasetCommand";
+import { ListFilesIdsQuery } from "./Messages/ListFilesIdsQuery";
+import { ReadFileQuery } from "./Messages/ReadFileQuery";
+export class RawTextDataset extends DatasetBase {
+    _db;
+    dataset;
+    constructor(_db, dataset) {
+        super(_db, dataset);
+        this._db = _db;
+        this.dataset = dataset;
+    }
+    async Read(id, offset = 0, limit = 0) {
+        this.Log(`Reading "${id}" from "${this.DatasetPath}"...`);
+        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);
+        }
+        const content = queryResult.Result;
+        this.Log(`Read ${content.length} characters from "${id}" in "${this.DatasetPath}".`);
+        return content;
+    }
+    async GetAllIds() {
+        this.Log(`Fetching all files IDs from "${this.DatasetPath}"...`);
+        const queryResult = await this._db.Send(new ListFilesIdsQuery(this._db.DatabaseDir, this.dataset));
+        if (!queryResult.IsSuccess) {
+            throw new Error("Failed to fetch all items ids: " + queryResult.ErrorMessage);
+        }
+        const ids = queryResult.Result;
+        this.Log(`Found ${ids.length} files in "${this.DatasetPath}".`);
+        return ids;
+    }
+    async Create(id) {
+        this.Log(`Creating "${id}" in "${this.DatasetPath}"...`);
+        const result = await this._db.Send(new CreateFileCommand(this._db.DatabaseDir, this.dataset, id));
+        if (!result.IsSuccess) {
+            throw new Error("Failed to create item: " + result.ErrorMessage);
+        }
+        this.Log(`"${id}" created in "${this.DatasetPath}".`);
+    }
+    ;
+    async AppendText(id, text) {
+        this.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.Log(`${text.length} characters appended to "${id}" in "${this.DatasetPath}".`);
+    }
+    ;
+    async AppendLine(id, line) {
+        await this.AppendText(id, line + "\n");
+    }
+    async Delete(id) {
+        this.Log(`Deleting "${id}" from "${this.DatasetPath}"...`);
+        const result = await this._db.Send(new DeleteFileCommand(this._db.DatabaseDir, this.dataset, id));
+        if (!result.IsSuccess) {
+            throw new Error("Failed to delete item: " + result.ErrorMessage);
+        }
+        this.Log(`Deleted "${id}" from "${this.DatasetPath}".`);
+    }
+    async Drop() {
+        this.Log(`Dropping "${this.DatasetPath}"...`);
+        const result = await this._db.Send(new DropDatasetCommand(this._db.DatabaseDir, this.dataset));
+        if (!result.IsSuccess) {
+            throw new Error("Failed to drop dataset: " + result.ErrorMessage);
+        }
+        this.Log(`"${this.DatasetPath}" dropped.`);
+    }
+}

package/TextConverter.d.ts

@@ -0,0 +1,4 @@
+export interface TextConverter<T> {
+    ToLine(entry: T): string;
+    ToEntry(line: string): T;
+}

package/TextConverter.js

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

package/TextDataset.d.ts

@@ -1,16 +1,12 @@
-import { DatasetBase } from "./DatasetBase";
-import { ITextRepo } from "./ITextRepo";
 import { OnlineStorage } from "./OnlineStorage";
+import { RawTextDataset } from "./RawTextDataset";
+import { TextConverter } from "./TextConverter";
 import { dir } from "./Types/dir";
-export declare class TextDataset extends DatasetBase implements ITextRepo {
+export declare class TextDataset<T> extends RawTextDataset {
     protected _db: OnlineStorage;
     protected dataset: dir;
-    constructor(_db: OnlineStorage, dataset: dir);
-    Read(id: string, offset?: number, limit?: number): Promise<string[]>;
-    GetAllIds(): Promise<string[]>;
-    Create(id: string): Promise<void>;
-    AppendText(id: string, text: string): Promise<void>;
-    AppendLine(id: string, line: string): Promise<void>;
-    Delete(id: string): Promise<void>;
-    Drop(): Promise<void>;
+    protected _converter: TextConverter<T>;
+    constructor(_db: OnlineStorage, dataset: dir, _converter?: TextConverter<T>);
+    Load(id: string, offset?: number, limit?: number): Promise<T[]>;
+    Append(id: string, entry: T): Promise<void>;
 }

package/TextDataset.js

@@ -1,73 +1,21 @@
-import { DatasetBase } from "./DatasetBase";
-import { AppendCommand } from "./Messages/AppendCommand";
-import { CreateFileCommand } from "./Messages/CreateFileCommand";
-import { DeleteFileCommand } from "./Messages/DeleteFileCommand";
-import { DropDatasetCommand } from "./Messages/DropDatasetCommand";
-import { ListFilesIdsQuery } from "./Messages/ListFilesIdsQuery";
-import { ReadFileQuery } from "./Messages/ReadFileQuery";
-export class TextDataset extends DatasetBase {
+import { JsonTextConverter } from "./JsonTextConverter";
+import { RawTextDataset } from "./RawTextDataset";
+export class TextDataset extends RawTextDataset {
     _db;
     dataset;
-    constructor(_db, dataset) {
+    _converter;
+    constructor(_db, dataset, _converter = new JsonTextConverter()) {
         super(_db, dataset);
         this._db = _db;
         this.dataset = dataset;
+        this._converter = _converter;
     }
-    async Read(id, offset = 0, limit = 0) {
-        this.Log(`Reading "${id}" from "${this.DatasetPath}"...`);
-        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);
-        }
-        const content = queryResult.Result;
-        this.Log(`Read ${content.length} characters from "${id}" in "${this.DatasetPath}".`);
-        return content;
+    async Load(id, offset = 0, limit = 0) {
+        const lines = await super.Read(id, offset, limit);
+        return lines.map(line => this._converter.ToEntry(line));
     }
-    async GetAllIds() {
-        this.Log(`Fetching all files IDs from "${this.DatasetPath}"...`);
-        const queryResult = await this._db.Send(new ListFilesIdsQuery(this._db.DatabaseDir, this.dataset));
-        if (!queryResult.IsSuccess) {
-            throw new Error("Failed to fetch all items ids: " + queryResult.ErrorMessage);
-        }
-        const ids = queryResult.Result;
-        this.Log(`Found ${ids.length} files in "${this.DatasetPath}".`);
-        return ids;
-    }
-    async Create(id) {
-        this.Log(`Creating "${id}" in "${this.DatasetPath}"...`);
-        const result = await this._db.Send(new CreateFileCommand(this._db.DatabaseDir, this.dataset, id));
-        if (!result.IsSuccess) {
-            throw new Error("Failed to create item: " + result.ErrorMessage);
-        }
-        this.Log(`"${id}" created in "${this.DatasetPath}".`);
-    }
-    ;
-    async AppendText(id, text) {
-        this.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.Log(`${text.length} characters appended to "${id}" in "${this.DatasetPath}".`);
-    }
-    ;
-    async AppendLine(id, line) {
-        await this.AppendText(id, line + "\n");
-    }
-    async Delete(id) {
-        this.Log(`Deleting "${id}" from "${this.DatasetPath}"...`);
-        const result = await this._db.Send(new DeleteFileCommand(this._db.DatabaseDir, this.dataset, id));
-        if (!result.IsSuccess) {
-            throw new Error("Failed to delete item: " + result.ErrorMessage);
-        }
-        this.Log(`Deleted "${id}" from "${this.DatasetPath}".`);
-    }
-    async Drop() {
-        this.Log(`Dropping "${this.DatasetPath}"...`);
-        const result = await this._db.Send(new DropDatasetCommand(this._db.DatabaseDir, this.dataset));
-        if (!result.IsSuccess) {
-            throw new Error("Failed to drop dataset: " + result.ErrorMessage);
-        }
-        this.Log(`"${this.DatasetPath}" dropped.`);
+    async Append(id, entry) {
+        const line = this._converter.ToLine(entry);
+        await super.AppendLine(id, line);
     }
 }

package/index.d.ts

@@ -5,11 +5,14 @@ export * from "./IStorageUser";
 export * from "./IConverter";
 export * from "./Converter";
 export * from "./DummyConverter";
+export * from "./TextConverter";
+export * from "./JsonTextConverter";
 export * from "./IRepoBase";
 export * from "./IRepo";
 export * from "./ITextRepo";
 export * from "./IRepos";
 export * from "./Dataset";
+export * from "./RawTextDataset";
 export * from "./TextDataset";
 export * from "./Datasets";
 export * from "./OnlineStorage";

package/index.js

@@ -5,11 +5,14 @@ export * from "./IStorageUser";
 export * from "./IConverter";
 export * from "./Converter";
 export * from "./DummyConverter";
+export * from "./TextConverter";
+export * from "./JsonTextConverter";
 export * from "./IRepoBase";
 export * from "./IRepo";
 export * from "./ITextRepo";
 export * from "./IRepos";
 export * from "./Dataset";
+export * from "./RawTextDataset";
 export * from "./TextDataset";
 export * from "./Datasets";
 export * from "./OnlineStorage";

package/package.json

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