3.0.6

npmextra.json

@@ -8,7 +8,7 @@
       "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "description": "A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.",
+      "description": "A TypeScript library for cloud-independent object storage, providing features like bucket creation, file and directory management, and data streaming.",
       "npmPackagename": "@push.rocks/smartbucket",
       "license": "MIT",
       "keywords": [
@@ -26,7 +26,12 @@
         "unified storage",
         "buffer handling",
         "access key",
-        "secret key"
+        "secret key",
+        "metadata",
+        "file locking",
+        "file streaming",
+        "directory listing",
+        "cloud agnostic"
       ]
     }
   },

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@push.rocks/smartbucket",
-      "version": "3.0.4",
+      "version": "3.0.6",
       "license": "UNLICENSED",
       "dependencies": {
         "@push.rocks/smartpath": "^5.0.18",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.0.4",
-  "description": "A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.",
+  "version": "3.0.6",
+  "description": "A TypeScript library for cloud-independent object storage, providing features like bucket creation, file and directory management, and data streaming.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -58,6 +58,11 @@
     "unified storage",
     "buffer handling",
     "access key",
-    "secret key"
+    "secret key",
+    "metadata",
+    "file locking",
+    "file streaming",
+    "directory listing",
+    "cloud agnostic"
   ]
 }

readme.md

@@ -1,5 +1,6 @@
 # @push.rocks/smartbucket
-A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.
+
+A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.
 
 ## Install
 
@@ -199,12 +200,15 @@ writeFileStream("exampleBucket", "path/to/streamedObject.txt", readable);
 
 `@push.rocks/smartbucket` abstracts directories within buckets for easier object management. You can create, list, and delete directories using the `Directory` class.
 
+Here's how to list the contents of a directory:
+
 ```typescript
 async function listDirectoryContents(bucketName: string, directoryPath: string) {
   const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
   if (myBucket) {
     const baseDirectory: Directory = await myBucket.getBaseDirectory();
     const targetDirectory: Directory = await baseDirectory.getSubDirectoryByName(directoryPath);
+    
     console.log('Listing directories:');
     const directories = await targetDirectory.listDirectories();
     directories.forEach(dir => {
@@ -304,6 +308,8 @@ Remember, each cloud provider has specific features and limitations. `@push.rock
 
 This guide covers the basic to advanced scenarios of using `@push.rocks/smartbucket`. For further details, refer to the API documentation and examples.
 
+
+
 ## License and Legal Information
 
 This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.0.4',
-  description: 'A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.'
+  version: '3.0.6',
+  description: 'A TypeScript library for cloud-independent object storage, providing features like bucket creation, file and directory management, and data streaming.'
 }

ts/classes.file.ts

@@ -102,7 +102,7 @@ export class File {
     const metadata = await this.getMetaData();
     await metadata.setLock({
       lock: 'locked',
-      expires: new Date(Date.now() + (optionsArg?.timeoutMillis || 1000)),
+      expires: Date.now() + (optionsArg?.timeoutMillis || 1000),
     });
   }
 
@@ -116,7 +116,10 @@ export class File {
      */
     force?: boolean;
   }) {
-
+    const metadata = await this.getMetaData();
+    await metadata.removeLock({
+      force: optionsArg?.force,
+    });
   }
 
   public async updateWithContents(optionsArg: {
@@ -146,9 +149,27 @@ export class File {
    * @param updatedMetadata
    */
   public async getMetaData() {
+    if (this.name.endsWith('.metadata')) {
+      throw new Error('metadata files cannot have metadata');
+    }
     const metadata = await MetaData.createForFile({
       file: this,
     });
     return metadata;
   }
+
+  /**
+   * gets the contents as json
+   */
+  public async getJsonData() {
+    const json = await this.getContentsAsString();
+    const parsed = await JSON.parse(json);
+    return parsed;
+  }
+
+  public async writeJsonData(dataArg: any) {
+    await this.updateWithContents({
+      contents: JSON.stringify(dataArg),
+    });
+  }
 }

ts/classes.metadata.ts

@@ -4,9 +4,7 @@ import { File } from './classes.file.js';
 
 export class MetaData {
   // static
-  public static async createForFile(optionsArg: {
-    file: File;
-  }) {
+  public static async createForFile(optionsArg: { file: File }) {
     const metaData = new MetaData();
     metaData.fileRef = optionsArg.file;
 
@@ -34,10 +32,10 @@ export class MetaData {
     useFileExtension?: boolean;
     useMagicBytes?: boolean;
   }): Promise<string> {
-    if (optionsArg && optionsArg.useFileExtension || optionsArg.useFileExtension === undefined) {
+    if ((optionsArg && optionsArg.useFileExtension) || optionsArg.useFileExtension === undefined) {
       return plugins.path.extname(this.fileRef.name);
     }
-  };
+  }
 
   /**
    * gets the size of the fileRef
@@ -47,59 +45,56 @@ export class MetaData {
       path: this.fileRef.getBasePath(),
     });
     return stat.size;
-  };
+  }
 
   private prefixCustomMetaData = 'custom_';
 
-  public async storeCustomMetaData<T = any>(optionsArg: {
-    key: string;
-    value: T;
-  }) {
-    const json = await this.metadataFile.getContentsAsString();
-    const parsed = await JSON.parse(json);
-    parsed[this.prefixCustomMetaData + optionsArg.key] = optionsArg.value;
-    await this.metadataFile.updateWithContents({
-      contents: JSON.stringify(parsed),
-    });
+  public async storeCustomMetaData<T = any>(optionsArg: { key: string; value: T }) {
+    const data = await this.metadataFile.getContentsAsString();
+    data[this.prefixCustomMetaData + optionsArg.key] = optionsArg.value;
+    await this.metadataFile.writeJsonData(data);
   }
 
-  public async getCustomMetaData<T = any>(optionsArg: {
-    key: string;
-  }): Promise<T> {
-    const json = await this.metadataFile.getContentsAsString();
-    const parsed = await JSON.parse(json);
-    return parsed[this.prefixCustomMetaData + optionsArg.key];
+  public async getCustomMetaData<T = any>(optionsArg: { key: string }): Promise<T> {
+    const data = await this.metadataFile.getJsonData();
+    return data[this.prefixCustomMetaData + optionsArg.key];
   }
 
-  public async deleteCustomMetaData(optionsArg: {
-    key: string;
-  }) {
-    const json = await this.metadataFile.getContentsAsString();
-    const parsed = await JSON.parse(json);
-    delete parsed[this.prefixCustomMetaData + optionsArg.key];
-    await this.metadataFile.updateWithContents({
-      contents: JSON.stringify(parsed),
-    });
+  public async deleteCustomMetaData(optionsArg: { key: string }) {
+    const data = await this.metadataFile.getJsonData();
+    delete data[this.prefixCustomMetaData + optionsArg.key];
+    await this.metadataFile.writeJsonData(data);
   }
 
   /**
    * set a lock on the ref file
    * @param optionsArg
    */
-  public async setLock(optionsArg: {
-    lock: string;
-    expires: Date;
-  }) {
-    
+  public async setLock(optionsArg: { lock: string; expires: number }) {
+    const data = await this.metadataFile.getJsonData();
+    data.lock = optionsArg.lock;
+    data.lockExpires = optionsArg.expires;
+    await this.metadataFile.writeJsonData(data);
   }
 
   /**
    * remove the lock on the ref file
    * @param optionsArg
    */
-  public async removeLock(optionsArg: {
-    force: boolean;
-  }) {
+  public async removeLock(optionsArg: { force: boolean }) {
+    const data = await this.metadataFile.getJsonData();
+    delete data.lock;
+    delete data.lockExpires;
+    await this.metadataFile.writeJsonData(data);
+  }
 
+  public async checkLocked(): Promise<boolean> {
+    const data = await this.metadataFile.getJsonData();
+    return data.lock && data.lockExpires > Date.now();
+  }
+
+  public async getLockInfo(): Promise<{ lock: string; expires: number }> {
+    const data = await this.metadataFile.getJsonData();
+    return { lock: data.lock, expires: data.lockExpires };
   }
 }