@tblabs/storage 5.15.4 → 5.15.6

package/Datasets/File/FileDataset.d.ts

@@ -4,7 +4,8 @@ import { DatasetBase } from "../DatasetBase";
 import { DatasetType } from "../../Services/DatasetType";
 import { FilePack } from "./FilePack";
 import { FilesUploadConfig } from "../../Models/FilesUploadConfig";
-export declare class FileDataset extends DatasetBase {
+import { IFileDataset } from "./IFileDataset";
+export declare class FileDataset extends DatasetBase implements IFileDataset {
     protected _db: OnlineStorage;
     protected dataset: dir;
     Type: DatasetType;

package/Datasets/File/IFileDataset.d.ts

@@ -0,0 +1,13 @@
+import { FilesUploadConfig } from "../../Models/FilesUploadConfig";
+import { DatasetType } from "../../Services/DatasetType";
+import { FilePack } from "./FilePack";
+export interface IFileDataset {
+    Type: DatasetType;
+    SetConfig(config: Partial<FilesUploadConfig>): void;
+    GetConfig(): FilesUploadConfig;
+    GetAllIds(): Promise<string[]>;
+    GetOne(fileId: string): Promise<FilePack>;
+    GetAll(): Promise<FilePack[]>;
+    Add(files: File[]): Promise<FilePack[]>;
+    Delete(fileId: string): Promise<void>;
+}

package/Datasets/Object/{IRepo.d.ts → IObjectDataset.d.ts}

@@ -1,10 +1,10 @@
-import { IRepoBase } from "../IRepoBase";
-export interface IRepo<T> extends IRepoBase {
-    Add(id: string, item: T): Promise<void>;
+import { DatasetType } from "../../Services/DatasetType";
+export interface IObjectDataset<T extends object> {
+    Type: DatasetType.Object;
     GetOne(id: string): Promise<T>;
     GetAll(): Promise<T[]>;
     GetAllIds(): Promise<string[]>;
+    Add(id: string, item: T): Promise<void>;
     Update(id: string, item: T): Promise<void>;
     Delete(id: string): Promise<void>;
-    Drop(): Promise<void>;
 }

package/Datasets/Object/IObjectDataset.js

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

package/Datasets/Object/IObjectDatasets.d.ts

@@ -0,0 +1,14 @@
+import { OnlineStorage } from "../../Services/OnlineStorage";
+import { dir } from "../../Types/dir";
+export interface IObjectDatasets<T extends object> {
+    get Names(): string[];
+    get Database(): OnlineStorage;
+    GetOne(dataset: dir, id: string): Promise<T>;
+    GetAll(dataset: dir): Promise<T[]>;
+    GetAllIds(dataset: dir): Promise<string[]>;
+    Add(dataset: dir, id: string, item: T): Promise<void>;
+    Update(dataset: dir, id: string, item: T): Promise<void>;
+    Move(id: string, sourceDataset: dir, targetDataset: dir): Promise<void>;
+    Delete(dataset: dir, id: string): Promise<void>;
+    Drop(datasets?: dir[]): Promise<void>;
+}

package/Datasets/Object/IObjectDatasets.js

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

package/Datasets/Object/ObjectDataset.d.ts

@@ -1,14 +1,14 @@
+import { dir } from "../../Types/dir";
 import { OnlineStorage } from "../../Services/OnlineStorage";
 import { IConverter } from "../../Converters/IConverter";
-import { IRepo } from "./IRepo";
-import { dir } from "../../Types/dir";
 import { DatasetBase } from "../DatasetBase";
 import { DatasetType } from "../../Services/DatasetType";
-export declare class ObjectDataset<T extends object> extends DatasetBase implements IRepo<T> {
+import { IObjectDataset } from "./IObjectDataset";
+export declare class ObjectDataset<T extends object> extends DatasetBase implements IObjectDataset<T> {
     protected _db: OnlineStorage;
     protected dataset: dir;
     protected _converter: IConverter<any, T>;
-    Type: DatasetType;
+    readonly Type: DatasetType.Object;
     constructor(_db: OnlineStorage, dataset: dir, _converter?: IConverter<any, T>);
     GetOne(id: string): Promise<T>;
     GetAll(): Promise<T[]>;

package/Datasets/Object/ObjectDatasets.d.ts

@@ -1,8 +1,8 @@
+import { dir } from "../../Types/dir";
 import { IConverter } from "../../Converters/IConverter";
-import { IRepos } from "./IRepos";
 import { OnlineStorage } from "../../Services/OnlineStorage";
-import { dir } from "../../Types/dir";
-export declare class ObjectDatasets<T extends object> implements IRepos<T> {
+import { IObjectDatasets } from "./IObjectDatasets";
+export declare class ObjectDatasets<T extends object> implements IObjectDatasets<T> {
     private _db;
     private datasets;
     private _converter;

package/Datasets/Object/ObjectDatasets.js

@@ -25,60 +25,6 @@ export class ObjectDatasets {
     get Database() {
         return this._db;
     }
-    // public CanUserDo(action: keyof IStorageUserPrivileges): boolean
-    // {
-    // 	if (!this._db.User.Privileges)
-    // 	{
-    // 		return false;
-    // 	}
-    // 	const privilege = this._db.User.Privileges[action];
-    // 	if (!privilege)
-    // 	{
-    // 		return false;
-    // 	}
-    // 	// ex. AddFile: { Datasets: "all" } or AddFile: { Datasets: ["Public"] }
-    // 	if (typeof privilege === "object")
-    // 	{
-    // 		const allowedDatasets = privilege.Datasets;
-    // 		// ex. AddFile: { Datasets: "all" }
-    // 		if (typeof allowedDatasets === "string")
-    // 		{
-    // 			if (allowedDatasets == "all")
-    // 			{
-    // 				return true;
-    // 			}
-    // 			else if (allowedDatasets == "none")
-    // 			{
-    // 				return false;
-    // 			}
-    // 			else
-    // 			{
-    // 				return false;
-    // 			}
-    // 		}
-    // 		// ex. AddFile: { Datasets: ["Public"] }
-    // 		else if (typeof allowedDatasets === "object")
-    // 		{
-    // 			if (Array.isArray(allowedDatasets))
-    // 			{
-    // 				for (const dataset of this.datasets)
-    // 				{
-    // 					if (allowedDatasets.includes(dataset))
-    // 					{
-    // 						return true;
-    // 					}
-    // 				}
-    // 				return false;
-    // 			}
-    // 		}
-    // 	}
-    // 	// ex. CreateUser: true
-    // 	else if (typeof privilege === "boolean")
-    // 	{
-    // 		return privilege;
-    // 	}
-    // 	return false;
-    // }
     async GetOne(dataset, id) {
         this._db.Log(`Fetching "${id}" from "${dataset}"...`);
         const queryResult = await this._db.Send(new GetObjectQuery(this._db.DatabaseDir, dataset, id));

package/Datasets/Picture/IPictureDataset.d.ts

@@ -0,0 +1,13 @@
+import { DatasetType } from "../../Services/DatasetType";
+import { PicsConfig } from "./PicsConfig";
+import { PicturePack } from "./PicturePack";
+export interface IPictureDataset {
+    Type: DatasetType;
+    SetConfig(config: Partial<PicsConfig>): void;
+    GetConfig(): PicsConfig;
+    GetAllIds(): Promise<string[]>;
+    GetOne(pictureDir: string): Promise<PicturePack>;
+    GetAll(): Promise<PicturePack[]>;
+    Add(files: File[]): Promise<PicturePack[]>;
+    Delete(pictureDir: string): Promise<void>;
+}

package/Datasets/Picture/IPictureDataset.js

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

package/Datasets/Picture/PictureDataset.d.ts

@@ -4,7 +4,8 @@ import { DatasetBase } from "../DatasetBase";
 import { PicsConfig } from "./PicsConfig";
 import { PicturePack } from "./PicturePack";
 import { DatasetType } from "../../Services/DatasetType";
-export declare class PictureDataset extends DatasetBase {
+import { IPictureDataset } from "./IPictureDataset";
+export declare class PictureDataset extends DatasetBase implements IPictureDataset {
     protected _db: OnlineStorage;
     protected dataset: dir;
     Type: DatasetType;

package/Datasets/Text/IRawTextDataset.d.ts

@@ -0,0 +1,12 @@
+import { DatasetType } from "../../Services/DatasetType";
+export interface IRawTextDataset {
+    Type: DatasetType;
+    Read(id: string, offset?: number, limit?: number): Promise<string[]>;
+    GetAllIds(): Promise<string[]>;
+    Create(id: string): Promise<void>;
+    AppendText(id: string, text: string): Promise<void>;
+    Clear(id: string): Promise<void>;
+    ReplaceText(id: string, text: string): Promise<void>;
+    AppendLine(id: string, line: string): Promise<void>;
+    Delete(id: string): Promise<void>;
+}

package/Datasets/Text/IRawTextDataset.js

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

package/Datasets/Text/ITextDataset.d.ts

@@ -0,0 +1,4 @@
+export interface ITextDataset<T> {
+    Load(id: string, offset?: number, limit?: number): Promise<T[]>;
+    Append(id: string, entry: T): Promise<void>;
+}

package/Datasets/Text/ITextDataset.js

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

package/Datasets/Text/RawTextDataset.d.ts

@@ -1,9 +1,9 @@
 import { DatasetBase } from "../DatasetBase";
-import { ITextRepo } from "./ITextRepo";
 import { DatasetType } from "../../Services/DatasetType";
 import { OnlineStorage } from "../../Services/OnlineStorage";
 import { dir } from "../../Types/dir";
-export declare class RawTextDataset extends DatasetBase implements ITextRepo {
+import { IRawTextDataset } from "./IRawTextDataset";
+export declare class RawTextDataset extends DatasetBase implements IRawTextDataset {
     protected _db: OnlineStorage;
     protected dataset: dir;
     Type: DatasetType;

package/Datasets/Text/TextDataset.d.ts

@@ -2,7 +2,8 @@ import { OnlineStorage } from "../../Services/OnlineStorage";
 import { RawTextDataset } from "./RawTextDataset";
 import { ITextConverter } from "../../Converters/ITextConverter";
 import { dir } from "../../Types/dir";
-export declare class TextDataset<T> extends RawTextDataset {
+import { ITextDataset } from "./ITextDataset";
+export declare class TextDataset<T> extends RawTextDataset implements ITextDataset<T> {
     protected _db: OnlineStorage;
     protected dataset: dir;
     protected _converter: ITextConverter<T>;

package/Messages/GetMetadataQuery.d.ts

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

package/Messages/GetMetadataQuery.js

@@ -4,3 +4,8 @@ export class GetMetadataQuery extends Message {
         super("GetMetadata", { Database, Dataset });
     }
 }
+export class UpdateMetadataQuery extends Message {
+    constructor(Database, Dataset, Metadata) {
+        super("UpdateMetadata", { Database, Dataset, Metadata });
+    }
+}

package/Services/IOnlineStorage.d.ts

@@ -0,0 +1,50 @@
+import { IConverter } from "../Converters/IConverter";
+import { ITextConverter } from "../Converters/ITextConverter";
+import { FileDataset } from "../Datasets/File/FileDataset";
+import { ObjectDataset } from "../Datasets/Object/ObjectDataset";
+import { ObjectDatasets } from "../Datasets/Object/ObjectDatasets";
+import { PicsConfig } from "../Datasets/Picture/PicsConfig";
+import { PictureDataset } from "../Datasets/Picture/PictureDataset";
+import { RawTextDataset } from "../Datasets/Text/RawTextDataset";
+import { TextDataset } from "../Datasets/Text/TextDataset";
+import { IMessage } from "../MessageBus/IMessage";
+import { MessageBusResponse } from "../MessageBus/MessageBusResponse";
+import { DatabaseInfo } from "../Models/DatabaseInfo";
+import { DatasetInfo } from "../Models/DatasetInfo";
+import { FilesUploadConfig } from "../Models/FilesUploadConfig";
+import { IStorageUser } from "../Models/IStorageUser";
+import { dir, url } from "../Types/dir";
+import { DatasetType } from "./DatasetType";
+export interface IOnlineStorage {
+    Server: string;
+    DatabaseDir: dir;
+    User: IStorageUser;
+    SetServer(server: url): this;
+    SetDatabase(database: dir): this;
+    SetUser(user: IStorageUser): this;
+    EnableLog(): this;
+    DisableLog(): this;
+    Log(...message: any[]): void;
+    Ping(): Promise<boolean>;
+    Send(message: IMessage): Promise<MessageBusResponse>;
+    ListDatasets(): Promise<DatasetInfo[]>;
+    CreateDataset(type: DatasetType, datasetName: string): Promise<void>;
+    DatasetExists(datasetName: string): Promise<boolean>;
+    RemoveDataset(datasetName: string): Promise<void>;
+    Move(fileId: string, sourceDataset: ObjectDataset<any>, targetDataset: ObjectDataset<any>): Promise<void>;
+    ListUsers(): Promise<IStorageUser[]>;
+    GetUser(userId: string): Promise<IStorageUser>;
+    UpdateUser(user: IStorageUser): Promise<void>;
+    AddUser(user: IStorageUser): Promise<void>;
+    DeleteUser(user: IStorageUser): Promise<void>;
+    ListDatabases(): Promise<DatabaseInfo[]>;
+    CreateDatabase(databaseName: string): Promise<void>;
+    DeleteDatabase(databaseName: string): Promise<void>;
+    GetLog(id: string): Promise<string>;
+    GetLogsList(): Promise<string[]>;
+    GetObjectDataset<T extends object>(dataset: dir, converter: IConverter<any, T>): ObjectDataset<T>;
+    GetObjectDatasets<T extends object>(datasets: dir[], converter?: IConverter<any, T>): ObjectDatasets<T>;
+    GetTextDataset(datasetName: string, converter?: ITextConverter<any>): TextDataset<any> | RawTextDataset;
+    GetPictureDataset(dataset: dir, picsConfig: PicsConfig): PictureDataset;
+    GetFileDataset(dataset: dir, config?: FilesUploadConfig): FileDataset;
+}

package/Services/IOnlineStorage.js

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

package/Services/OnlineStorage.d.ts

@@ -18,7 +18,9 @@ import { PicsConfig } from "../Datasets/Picture/PicsConfig";
 import { FileDataset } from "../Datasets/File/FileDataset";
 import { FilesUploadConfig } from "../Models/FilesUploadConfig";
 import { ObjectDatasets } from "../Datasets/Object/ObjectDatasets";
-export declare class OnlineStorage {
+import { IOnlineStorage } from "./IOnlineStorage";
+import { DatasetMetadata } from "../Models/DatasetMetadata";
+export declare class OnlineStorage implements IOnlineStorage {
     private server;
     private database;
     private sender;
@@ -46,6 +48,8 @@ export declare class OnlineStorage {
     GetTextDataset(datasetName: string, converter?: ITextConverter<any>): TextDataset<any> | RawTextDataset;
     GetPictureDataset(datasetName: string, picsConfig?: PicsConfig): PictureDataset;
     GetFileDataset(datasetName: string, config?: Partial<FilesUploadConfig>): FileDataset;
+    GetDatasetMetadata(datasetName: string): Promise<DatasetMetadata>;
+    UpdateDatasetMetadata(datasetName: string, metadata: DatasetMetadata): Promise<void>;
     private IsBrowserEnvironment;
     private LoadUserFromLocalStorage;
     Login(password: string, login?: string): Promise<IStorageUser>;

package/Services/OnlineStorage.js

@@ -21,6 +21,7 @@ import { TextDataset } from "../Datasets/Text/TextDataset";
 import { PictureDataset } from "../Datasets/Picture/PictureDataset";
 import { FileDataset } from "../Datasets/File/FileDataset";
 import { ObjectDatasets } from "../Datasets/Object/ObjectDatasets";
+import { GetMetadataQuery, UpdateMetadataQuery } from "../Messages/GetMetadataQuery";
 export class OnlineStorage {
     server;
     database;
@@ -126,6 +127,22 @@ export class OnlineStorage {
     GetFileDataset(datasetName, config) {
         return new FileDataset(this, datasetName, config);
     }
+    async GetDatasetMetadata(datasetName) {
+        const response = await this.Send(new GetMetadataQuery(this.DatabaseDir, datasetName));
+        if (!response.IsSuccess && response.ErrorMessage.includes("not exist")) {
+            return {};
+        }
+        else if (!response.IsSuccess) {
+            throw new Error(`Failed to get metadata for dataset "${datasetName}": ${response.ErrorMessage}`);
+        }
+        return response.Result;
+    }
+    async UpdateDatasetMetadata(datasetName, metadata) {
+        const response = await this.Send(new UpdateMetadataQuery(this.DatabaseDir, datasetName, metadata));
+        if (!response.IsSuccess) {
+            throw new Error(`Failed to update metadata for dataset "${datasetName}": ${response.ErrorMessage}`);
+        }
+    }
     IsBrowserEnvironment() {
         return typeof window !== "undefined" && typeof window.localStorage !== "undefined";
     }

package/index.d.ts

@@ -4,28 +4,33 @@ export * from "./Models/IEntitiesSet";
 export * from "./Models/IStorageUser";
 export * from "./Models/DatabaseInfo";
 export * from "./Datasets/IRepoBase";
-export * from "./Datasets/Object/IRepo";
 export * from "./Datasets/Text/ITextRepo";
-export * from "./Datasets/Object/IRepos";
 export * from "./Models/DatasetMetadata";
 export * from "./Datasets/DatasetBase";
 export * from "./Services/DatasetType";
 export * from "./Converters/IConverter";
 export * from "./Converters/Converter";
+export * from "./Datasets/Object/IObjectDataset";
+export * from "./Datasets/Object/IObjectDatasets";
 export * from "./Datasets/Object/ObjectDataset";
 export * from "./Datasets/Object/ObjectDatasets";
 export * from "./Converters/DummyConverter";
+export * from "./Datasets/Text/IRawTextDataset";
+export * from "./Datasets/Text/ITextDataset";
 export * from "./Datasets/Text/RawTextDataset";
 export * from "./Datasets/Text/TextDataset";
 export * from "./Converters/ITextConverter";
 export * from "./Converters/JsonTextConverter";
+export * from "./Datasets/Picture/IPictureDataset";
 export * from "./Datasets/Picture/PictureDataset";
 export * from "./Datasets/Picture/PicConfig";
 export * from "./Datasets/Picture/PicsConfig";
 export * from "./Datasets/Picture/PicturePack";
 export * from "./Models/PictureDatasetMetadata";
+export * from "./Datasets/File/IFileDataset";
 export * from "./Datasets/File/FileDataset";
 export * from "./Datasets/File/FilePack";
 export * from "./Models/FileDatasetMetadata";
 export * from "./Models/FilesUploadConfig";
+export * from "./Services/IOnlineStorage";
 export * from "./Services/OnlineStorage";

package/index.js

@@ -4,9 +4,7 @@ export * from "./Models/IEntitiesSet";
 export * from "./Models/IStorageUser";
 export * from "./Models/DatabaseInfo";
 export * from "./Datasets/IRepoBase";
-export * from "./Datasets/Object/IRepo";
 export * from "./Datasets/Text/ITextRepo";
-export * from "./Datasets/Object/IRepos";
 // Common for datasets
 export * from "./Models/DatasetMetadata";
 export * from "./Datasets/DatasetBase";
@@ -14,24 +12,31 @@ export * from "./Services/DatasetType";
 export * from "./Converters/IConverter";
 export * from "./Converters/Converter";
 // Object datasets
+export * from "./Datasets/Object/IObjectDataset";
+export * from "./Datasets/Object/IObjectDatasets";
 export * from "./Datasets/Object/ObjectDataset";
 export * from "./Datasets/Object/ObjectDatasets";
 export * from "./Converters/DummyConverter";
 // Text datasets
+export * from "./Datasets/Text/IRawTextDataset";
+export * from "./Datasets/Text/ITextDataset";
 export * from "./Datasets/Text/RawTextDataset";
 export * from "./Datasets/Text/TextDataset";
 export * from "./Converters/ITextConverter";
 export * from "./Converters/JsonTextConverter";
 // Picture datasets
+export * from "./Datasets/Picture/IPictureDataset";
 export * from "./Datasets/Picture/PictureDataset";
 export * from "./Datasets/Picture/PicConfig";
 export * from "./Datasets/Picture/PicsConfig";
 export * from "./Datasets/Picture/PicturePack";
 export * from "./Models/PictureDatasetMetadata";
 // File datasets
+export * from "./Datasets/File/IFileDataset";
 export * from "./Datasets/File/FileDataset";
 export * from "./Datasets/File/FilePack";
 export * from "./Models/FileDatasetMetadata";
 export * from "./Models/FilesUploadConfig";
 // Storage
+export * from "./Services/IOnlineStorage";
 export * from "./Services/OnlineStorage";

package/package.json

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

package/Datasets/Object/IRepos.d.ts

@@ -1,9 +0,0 @@
-export interface IRepos<T> {
-    Add(dataset: string, id: string, item: T): Promise<void>;
-    GetAll(dataset: string): Promise<T[]>;
-    GetOne(dataset: string, id: string): Promise<T | null>;
-    Update(dataset: string, id: string, item: T): Promise<void>;
-    Delete(dataset: string, id: string): Promise<void>;
-    Drop(datasets?: string[]): Promise<void>;
-    Move(id: string, sourceDataset: string, targetDataset: string): Promise<void>;
-}

package/Datasets/Object/IRepos.js

@@ -1,2 +0,0 @@
-// import { IStorageUserPrivileges } from "../../Models/IStorageUserPrivileges";
-export {};