@tblabs/storage 5.9.1 → 5.10.0

package/Dataset.d.ts

@@ -2,23 +2,16 @@ import { OnlineStorage } from "./OnlineStorage";
 import { IConverter } from "./IConverter";
 import { IRepo } from "./IRepo";
 import { dir } from "./Types/dir";
-import { IStorageUserPrivileges } from "./IStorageUserPrivileges";
-export declare class Dataset<T extends object> implements IRepo<T> {
-    private _db;
-    private _converter;
-    private dataset;
+import { DatasetBase } from "./DatasetBase";
+export declare class Dataset<T extends object> extends DatasetBase implements IRepo<T> {
+    protected _db: OnlineStorage;
+    protected _converter: IConverter<any, T>;
+    protected dataset: dir;
     constructor(_db: OnlineStorage, _converter: IConverter<any, T>, dataset: dir);
-    get Name(): string;
-    get Database(): OnlineStorage;
-    private get DatasetPath();
-    CanUserDo(action: keyof IStorageUserPrivileges): boolean;
     GetOne(id: string): Promise<T>;
-    Read(id: string, offset?: number, limit?: 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,126 +5,83 @@ 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 {
+import { DatasetBase } from "./DatasetBase";
+export class Dataset extends DatasetBase {
     _db;
     _converter;
     dataset;
     constructor(_db, _converter, dataset) {
+        super(_db, dataset);
         this._db = _db;
         this._converter = _converter;
         this.dataset = dataset;
     }
-    get Name() {
-        return this.dataset;
-    }
-    get Database() {
-        return this._db;
-    }
-    get DatasetPath() {
-        return this._db.DatabaseDir + "/Datasets/" + this.dataset;
-    }
-    CanUserDo(action) {
-        if (!this._db.User.Privileges) {
-            return false;
-        }
-        if (typeof this._db.User.Privileges[action] === "object" && this._db.User.Privileges[action]) {
-            return (this._db.User.Privileges[action].Datasets == "all" || this._db.User.Privileges[action].Datasets?.includes(this.dataset)) ?? false;
-        }
-        if (typeof this._db.User.Privileges[action] === "boolean" && this._db.User.Privileges[action]) {
-            return this._db.User.Privileges[action];
-        }
-        return false;
-    }
     async GetOne(id) {
-        this._db.Log(`Fetching "${id}"...`);
+        this.Log(`Fetching "${id}"...`);
         const queryResult = await this._db.Send(new GetFileQuery(this._db.DatabaseDir, this.dataset, id));
         if (!queryResult.IsSuccess) {
             throw new Error("Failed to get one item: " + queryResult.ErrorMessage);
         }
         const rawItem = queryResult.Result;
         const item = this._converter.FromRaw(rawItem);
-        this._db.Log(`Fetched "${id}" from "${this.DatasetPath}".`);
+        this.Log(`Fetched "${id}" from "${this.DatasetPath}".`);
         return item;
     }
-    async Read(id, offset = 0, limit = 0) {
-        this._db.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._db.Log(`Read ${content.length} characters from "${id}" in "${this.DatasetPath}".`);
-        return content;
-    }
     async GetAll() {
-        this._db.Log(`Fetching all from "${this.DatasetPath}"...`);
+        this.Log(`Fetching all from "${this.DatasetPath}"...`);
         const queryResult = await this._db.Send(new ListFilesQuery(this._db.DatabaseDir, this.dataset));
         if (!queryResult.IsSuccess) {
             throw new Error("Failed to fetch all items: " + queryResult.ErrorMessage);
         }
         const rawItems = queryResult.Result;
         const items = rawItems.map((raw) => this._converter.FromRaw(raw));
-        this._db.Log(`Fetched ${items.length} items from "${this.DatasetPath}".`);
+        this.Log(`Fetched ${items.length} items from "${this.DatasetPath}".`);
         return items;
     }
     async GetAllIds() {
-        this._db.Log(`Fetching all files IDs from "${this.DatasetPath}"...`);
+        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._db.Log(`Found ${ids.length} files in "${this.DatasetPath}".`);
+        this.Log(`Found ${ids.length} files in "${this.DatasetPath}".`);
         return ids;
     }
     async Add(id, item) {
-        this._db.Log(`Adding "${id}" to "${this.DatasetPath}"...`);
+        this.Log(`Adding "${id}" to "${this.DatasetPath}"...`);
         const rawItem = this._converter.ToRaw(item);
         const result = await this._db.Send(new AddFileCommand(this._db.DatabaseDir, this.dataset, id, rawItem));
         if (!result.IsSuccess) {
             throw new Error("Failed to add item: " + result.ErrorMessage);
         }
-        this._db.Log(`"${id}" added to "${this.DatasetPath}".`);
+        this.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}"...`);
+        this.Log(`Updating "${id}"...`);
         const rawItem = this._converter.ToRaw(item);
         const result = await this._db.Send(new UpdateFileCommand(this._db.DatabaseDir, this.dataset, id, rawItem));
         if (!result.IsSuccess) {
             throw new Error("Failed to update item: " + result.ErrorMessage);
         }
-        this._db.Log(`"${id}" updated in "${this.DatasetPath}".`);
+        this.Log(`"${id}" updated in "${this.DatasetPath}".`);
     }
     ;
     async Delete(id) {
-        this._db.Log(`Deleting "${id}" from "${this.DatasetPath}"...`);
+        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._db.Log(`Deleted "${id}" from "${this.DatasetPath}".`);
+        this.Log(`Deleted "${id}" from "${this.DatasetPath}".`);
     }
     async Drop() {
-        this._db.Log(`Dropping "${this.DatasetPath}"...`);
+        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._db.Log(`"${this.DatasetPath}" dropped.`);
+        this.Log(`"${this.DatasetPath}" dropped.`);
     }
 }

package/DatasetBase.d.ts

@@ -0,0 +1,13 @@
+import { IStorageUserPrivileges } from "./IStorageUserPrivileges";
+import { OnlineStorage } from "./OnlineStorage";
+import { dir } from "./Types/dir";
+export declare class DatasetBase {
+    protected _db: OnlineStorage;
+    protected dataset: dir;
+    constructor(_db: OnlineStorage, dataset: dir);
+    get Name(): string;
+    get Database(): OnlineStorage;
+    protected get DatasetPath(): string;
+    CanUserDo(action: keyof IStorageUserPrivileges): boolean;
+    protected Log(message: string): void;
+}

package/DatasetBase.js

@@ -0,0 +1,32 @@
+export class DatasetBase {
+    _db;
+    dataset;
+    constructor(_db, dataset) {
+        this._db = _db;
+        this.dataset = dataset;
+    }
+    get Name() {
+        return this.dataset;
+    }
+    get Database() {
+        return this._db;
+    }
+    get DatasetPath() {
+        return this._db.DatabaseDir + "/Datasets/" + this.dataset;
+    }
+    CanUserDo(action) {
+        if (!this._db.User.Privileges) {
+            return false;
+        }
+        if (typeof this._db.User.Privileges[action] === "object" && this._db.User.Privileges[action]) {
+            return (this._db.User.Privileges[action].Datasets == "all" || this._db.User.Privileges[action].Datasets?.includes(this.dataset)) ?? false;
+        }
+        if (typeof this._db.User.Privileges[action] === "boolean" && this._db.User.Privileges[action]) {
+            return this._db.User.Privileges[action];
+        }
+        return false;
+    }
+    Log(message) {
+        this._db.Log(message);
+    }
+}

package/IRepo.d.ts

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

package/IRepoBase.d.ts

@@ -0,0 +1,7 @@
+import { IStorageUserPrivileges } from "./IStorageUserPrivileges";
+import { OnlineStorage } from "./OnlineStorage";
+export interface IRepoBase {
+    get Name(): string;
+    get Database(): OnlineStorage;
+    CanUserDo(action: keyof IStorageUserPrivileges): boolean;
+}

package/IRepoBase.js

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

package/ITextRepo.d.ts

@@ -0,0 +1,10 @@
+import { IRepoBase } from "./IRepoBase";
+export interface ITextRepo extends IRepoBase {
+    Create(id: string): Promise<void>;
+    Read(id: string, offset: number, limit: number): Promise<string[]>;
+    GetAllIds(): Promise<string[]>;
+    AppendText(id: string, text: string): Promise<void>;
+    AppendLine(id: string, line: string): Promise<void>;
+    Delete(id: string): Promise<void>;
+    Drop(): Promise<void>;
+}

package/ITextRepo.js

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

package/Messages/CreateFileCommand.d.ts

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

package/Messages/CreateFileCommand.js

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

package/OnlineStorage.d.ts

@@ -9,6 +9,7 @@ import { IConverter } from "./IConverter";
 import { IStorageUserPrivileges } from "./IStorageUserPrivileges";
 import { DatabaseInfo } from "./DatabaseInfo";
 import { DatasetInfo } from "./DatasetInfo";
+import { TextDataset } from "./TextDataset";
 export declare class OnlineStorage {
     private server;
     private database;
@@ -31,6 +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;
     private IsBrowserEnvironment;
     private LoadUserFromLocalStorage;
     get User(): IStorageUser;

package/OnlineStorage.js

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

package/TextDataset.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 TextDataset 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/TextDataset.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 TextDataset 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/index.d.ts

@@ -5,9 +5,12 @@ export * from "./IStorageUser";
 export * from "./IConverter";
 export * from "./Converter";
 export * from "./DummyConverter";
+export * from "./IRepoBase";
 export * from "./IRepo";
+export * from "./ITextRepo";
 export * from "./IRepos";
 export * from "./Dataset";
+export * from "./TextDataset";
 export * from "./Datasets";
 export * from "./OnlineStorage";
 export * from "./Utils/OperationRepeater";

package/index.js

@@ -5,9 +5,12 @@ export * from "./IStorageUser";
 export * from "./IConverter";
 export * from "./Converter";
 export * from "./DummyConverter";
+export * from "./IRepoBase";
 export * from "./IRepo";
+export * from "./ITextRepo";
 export * from "./IRepos";
 export * from "./Dataset";
+export * from "./TextDataset";
 export * from "./Datasets";
 export * from "./OnlineStorage";
 export * from "./Utils/OperationRepeater";

package/package.json

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