3.1.1

.gitea/workflows/default_tags.yaml

@@ -119,6 +119,6 @@ jobs:
         run: |
           npmci node install stable
           npmci npm install
-          pnpm install -g @gitzone/tsdoc
+          pnpm install -g @git.zone/tsdoc
           npmci command tsdoc
         continue-on-error: true

changelog.md

@@ -0,0 +1,75 @@
+# Changelog
+
+## 2024-11-26 - 3.1.1 - fix(core)
+Fix S3 cache manager methods for better path encoding consistency
+
+- Corrected path parameter usage in S3 manager methods to ensure encoding and consistency.
+- Updated package.json Git dependencies for scoped packages.
+
+## 2024-11-24 - 3.1.0 - feat(core)
+Enhanced caching solution with optional configurations and improved documentation.
+
+- Improved package description and keywords for better discoverability.
+- Updated dependencies to latest versions.
+- Added strict type checking in TypeScript configurations.
+- Enhanced README with detailed usage instructions and examples.
+
+## 2024-05-29 to 2024-02-14 - 3.0.8
+Minor configuration updates and documentation changes.
+
+- Updated project description.
+- Modified tsconfig setup.
+- Adjustments to npmextra.json regarding githost.
+
+## 2024-02-14 - 3.0.7
+Core enhancements and bug fixes.
+
+- Fixed updates in the core module to improve stability.
+
+## 2024-02-14 - 3.0.6
+Core maintenance and updates.
+
+- Implemented minor fixes in the core module.
+
+## 2023-07-21 - 3.0.5
+Addressed core module adjustments.
+
+- Patched core module to rectify issues.
+
+## 2023-07-20 - 3.0.4
+Further improvements to core functionality.
+
+- Additional fixes applied to the core component.
+
+## 2023-07-11 to 2023-07-10 - 3.0.3
+Organizational and structural changes.
+
+- Transitioned to a new organizational scheme.
+
+## 2023-01-09 - 3.0.2
+Core module corrections.
+
+- Resolved various issues within the core module.
+
+## 2022-06-09 - 3.0.1
+Continuous enhancements in core functionality.
+
+- Continued bug fixes for core module efficiency.
+
+## 2022-04-04 to 2022-04-02 - 3.0.0
+Major release with significant updates.
+
+## 2022-03-22 - 2.0.0
+Significant breaking changes in core tech stack.
+
+- BREAKING CHANGE: Transitioned core module to ECMAScript Modules (ESM).
+
+## 2021-05-10 - 1.0.9
+Caching improvements and optimization.
+
+- Enhanced caching by properly respecting TTL across all cache levels.
+
+## 2020-02-15 to 2020-02-05 - 1.0.6 to 1.0.1
+Initial series of core module fixes and updates.
+
+- Persistent efforts to stabilize and improve core functionalities.

npmextra.json

@@ -2,17 +2,34 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "levelcache",
-      "description": "a cache that uses memory/disk/s3 as backup",
+      "description": "A versatile caching solution offering multi-level storage utilizing memory, disk, and Amazon S3 for efficient data management and backup.",
       "npmPackagename": "@push.rocks/levelcache",
       "license": "MIT",
-      "projectDomain": "push.rocks"
+      "projectDomain": "push.rocks",
+      "keywords": [
+        "caching",
+        "data storage",
+        "memory cache",
+        "disk cache",
+        "S3 storage",
+        "data backup",
+        "multi-level caching",
+        "performance",
+        "persistent storage",
+        "data retrieval",
+        "Node.js",
+        "TypeScript"
+      ]
     }
   },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis 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. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@push.rocks/levelcache",
-  "version": "3.0.7",
+  "version": "3.1.1",
   "private": false,
-  "description": "a cache that uses memory/disk/s3 as backup",
+  "description": "A versatile caching solution offering multi-level storage utilizing memory, disk, and Amazon S3 for efficient data management and backup.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -15,26 +15,26 @@
     "localPublish": "gitzone commit && pnpm run build && pnpm publish && pnpm publish --access public --registry=\"https://registry.npmjs.org\""
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.77",
-    "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^20.11.17"
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.44",
+    "@git.zone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.5.3",
+    "@types/node": "^22.9.3"
   },
   "dependencies": {
-    "@push.rocks/lik": "^6.0.12",
-    "@push.rocks/smartbucket": "^2.0.4",
+    "@push.rocks/lik": "^6.1.0",
+    "@push.rocks/smartbucket": "^3.3.3",
     "@push.rocks/smartcache": "^1.0.13",
     "@push.rocks/smartenv": "^5.0.12",
-    "@push.rocks/smartexit": "^1.0.21",
-    "@push.rocks/smartfile": "^11.0.4",
-    "@push.rocks/smartjson": "^5.0.10",
-    "@push.rocks/smartpath": "^5.0.11",
-    "@push.rocks/smartpromise": "^4.0.3",
-    "@push.rocks/smartstring": "^4.0.13",
-    "@push.rocks/smartunique": "^3.0.6",
+    "@push.rocks/smartexit": "^1.0.23",
+    "@push.rocks/smartfile": "^11.0.21",
+    "@push.rocks/smartjson": "^5.0.20",
+    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smartstring": "^4.0.15",
+    "@push.rocks/smartunique": "^3.0.9",
     "@push.rocks/taskbuffer": "^3.1.7",
-    "@tsclass/tsclass": "^4.0.51"
+    "@tsclass/tsclass": "^4.1.2"
   },
   "files": [
     "ts/**/*",
@@ -50,5 +50,24 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
-  ]
+  ],
+  "keywords": [
+    "caching",
+    "data storage",
+    "memory cache",
+    "disk cache",
+    "S3 storage",
+    "data backup",
+    "multi-level caching",
+    "performance",
+    "persistent storage",
+    "data retrieval",
+    "Node.js",
+    "TypeScript"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/levelcache",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/levelcache.git"
+  }
 }

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,40 +1,173 @@
 # @push.rocks/levelcache
-a cache that uses memory/disk/s3 as backup
+A cache that utilizes memory, disk, and S3 for data storage and backup.
 
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/levelcache)
-* [gitlab.com (source)](https://gitlab.com/push.rocks/levelcache)
-* [github.com (source mirror)](https://github.com/push.rocks/levelcache)
-* [docs (typedoc)](https://push.rocks.gitlab.io/levelcache/)
+## Install
+To install `@push.rocks/levelcache`, you can use npm or yarn:
 
-## Status for master
+```bash
+npm install @push.rocks/levelcache --save
+```
+or
+```bash
+yarn add @push.rocks/levelcache
+```
 
-Status Category | Status Badge
--- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/levelcache/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/levelcache/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/levelcache)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/levelcache)](https://lossless.cloud)
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/levelcache)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/levelcache)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/levelcache)](https://lossless.cloud)
+This installs `@push.rocks/levelcache` and adds it to your project's dependencies.
 
 ## Usage
 
-@pushrocks/levelcache implements an efficient way to cache larger amounts of data ind a multilevel approach.
-smaller and prioritized data is safed in memory.
+`@push.rocks/levelcache` provides a comprehensive solution for multi-level caching that takes advantage of memory, disk, and Amazon S3 storage, making it a versatile tool for data caching and backup. The package is built with TypeScript, enabling strict type checks and better development experience. Below, we'll explore how to effectively employ `@push.rocks/levelcache` in your projects, discussing its features and demonstrating its usage with code examples.
 
-Use TypeScript for best in class intellisense.
+### 1. Overview
 
-## Contribution
+The `LevelCache` class handles all cache operations. It decides where to store data based on pre-configured thresholds corresponding to the data size and the total storage capacity allocated for each storage type (memory/disk/S3). This mechanism optimizes both speed and persistence, allowing for efficient data storage and retrieval.
 
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+### 2. Getting Started: Initialization
 
-For further information read the linked docs at the top of this readme.
+To use `@push.rocks/levelcache`, you'll need to import the main classes: `LevelCache` and `CacheEntry`. `LevelCache` is the primary class, while `CacheEntry` represents individual pieces of cached data.
 
-## Legal
-> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+```typescript
+import { LevelCache, CacheEntry } from '@push.rocks/levelcache';
+```
+
+#### Initialization with Optional Configurations
+
+To create a cache, instantiate the `LevelCache` class with desired configurations. You can specify the limits for memory and disk storage, setup S3 configurations if needed, and more.
+
+```typescript
+const myCache = new LevelCache({
+  cacheId: 'myUniqueCacheId', // Unique ID for cache delineation
+  maxMemoryStorageInMB: 10, // Maximum memory use in MB (default 0.5 MB)
+  maxDiskStorageInMB: 100, // Maximum disk space in MB (default 10 MB)
+  diskStoragePath: './myCache', // Path for storing disk cache; default is '.nogit'
+  s3Config: {
+    accessKeyId: 'yourAccessKeyId', // AWS S3 access key
+    secretAccessKey: 'yourSecretAccessKey', // Corresponding secret key
+    region: 'us-west-2' // AWS region, e.g., 'us-west-2'
+  },
+  s3BucketName: 'myBucketName', // Designated name for S3 bucket
+  immutableCache: false, // Whether stored cache entries should remain unaltered
+  persistentCache: true, // Should the cache persist upon restarts
+});
+```
+
+### 3. Storing and Retrieving Data
+
+`LevelCache` methods enable seamless data storage and retrieval, handling complexity under the hood.
+
+#### Storing Data
+
+Create a `CacheEntry` specifying the data content and time-to-live (`ttl`). Use `storeCacheEntryByKey` to add this entry to the cache.
+
+```typescript
+async function storeData() {
+  // Wait for cache to be ready before operations
+  await myCache.ready;
+
+  const entryContents = Buffer.from('Caching this data');
+  const myCacheEntry = new CacheEntry({
+    ttl: 7200000, // Time-to-live in milliseconds (2 hours)
+    contents: entryContents,
+  });
+
+  // Storing the cache entry associated with a specific key
+  await myCache.storeCacheEntryByKey('someDataKey', myCacheEntry);
+}
+```
+
+#### Retrieving Data
+
+Retrieve stored data using `retrieveCacheEntryByKey`. The retrieved `CacheEntry` will give access to the original data.
+
+```typescript
+async function retrieveData() {
+  const retrievedEntry = await myCache.retrieveCacheEntryByKey('someDataKey');
+  if (retrievedEntry) {
+    const data = retrievedEntry.contents.toString();
+    console.log(data); // Expected output: Caching this data
+  } else {
+    console.log('Data not found or expired.');
+  }
+}
+```
+
+### 4. Key Management: Updating and Deleting
+
+#### Deleting Cache Entries
+
+Remove entries with `deleteCacheEntryByKey`, enabling clean cache management.
+
+```typescript
+async function deleteData() {
+  // Removes an entry using its unique key identifier
+  await myCache.deleteCacheEntryByKey('someDataKey');
+}
+```
+
+### 5. Cache Cleaning
+
+Often, managing storage limits or removing outdated data becomes essential. The library supports these scenarios.
+
+#### Automated Cleaning
+
+While cache entries will naturally expire with `ttl` values, you can force-remove outdated entries.
+
+```typescript
+// Clean outdated or expired entries
+await myCache.cleanOutdated();
+```
+
+#### Full Cache Reset
+
+Clear all entries, efficiently resetting your cache storage.
+
+```typescript
+// Flush entire cache content
+await myCache.cleanAll();
+```
+
+### 6. Configuring and Managing Advanced Use Cases
+
+The flexible nature of `@push.rocks/levelcache` grants additional customization suited for more advanced requirements.
+
+#### Custom Route Management
+
+For certain demands, you might want to specify distinct data handling policies or routing logic.
+
+- Adjust S3 handling, size thresholds, or immutability options dynamically.
+- Utilize internal API expansions defined within the library for fine-grained operations.
+
+#### Handling Large Datasets
+
+Tailor the cache levels (memory, disk, S3) to accommodate higher loads:
+
+```typescript
+const largeDatasetCache = new LevelCache({
+  cacheId: 'largeDatasetCache',
+  // Customize limits and behavior for particular patterns
+  maxMemoryStorageInMB: 1024, // 1 GB memory allocation
+  maxDiskStorageInMB: 2048, // 2 GB disk space allowance
+  maxS3StorageInMB: 10240, // 10 GB S3 backup buffering
+});
+```
+
+With intelligent routing and management embedded, `LevelCache` ensures optimal trade-offs between speed and stability.
+
+## 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. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.ts

@@ -35,7 +35,7 @@ tap.test('should respect ttl', async (tools) => {
   );
   const result = await testLevelCache.retrieveCacheEntryByKey('mykey');
   expect(result.contents.toString()).toEqual('heythere');
-  await tools.delayFor(1100);
+  await tools!.delayFor(1100);
   const result2 = await testLevelCache.retrieveCacheEntryByKey('mykey');
   expect(result2).toBeNull();
 });

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@push.rocks/levelcache',
-  version: '3.0.7',
-  description: 'a cache that uses memory/disk/s3 as backup'
+  version: '3.1.1',
+  description: 'A versatile caching solution offering multi-level storage utilizing memory, disk, and Amazon S3 for efficient data management and backup.'
 }

ts/levelcache.classes.cache.s3manager.ts

@@ -42,16 +42,18 @@ export class CacheS3Manager extends AbstractCache {
   }
 
   public async retrieveCacheEntryByKey(keyArg: string): Promise<CacheEntry> {
-    const jsonFileString = (await this.s3CacheDir.fastGet(encodeURIComponent(keyArg))).toString();
+    const jsonFileString = (await this.s3CacheDir.fastGet({
+      path: encodeURIComponent(keyArg),
+    })).toString();
     const cacheEntry = CacheEntry.fromStorageJsonString(jsonFileString);
     return cacheEntry;
   }
 
   public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry) {
-    await this.s3CacheDir.fastStore(
-      encodeURIComponent(keyArg),
-      cacheEntryArg.toStorageJsonString()
-    );
+    await this.s3CacheDir.fastPut({
+      path: encodeURIComponent(keyArg),
+      contents: cacheEntryArg.toStorageJsonString()
+    });
   }
 
   public async checkKeyPresence(keyArg: string): Promise<boolean> {
@@ -66,7 +68,9 @@ export class CacheS3Manager extends AbstractCache {
 
   public async deleteCacheEntryByKey(keyArg: string) {
     if (this.status === 'active') {
-      await this.s3CacheDir.fastRemove(encodeURIComponent(keyArg));
+      await this.s3CacheDir.fastRemove({
+        path: encodeURIComponent(keyArg),
+      });
     }
   }
 
@@ -76,6 +80,8 @@ export class CacheS3Manager extends AbstractCache {
   public async cleanOutdated() {}
 
   public async cleanAll() {
-    await this.s3CacheDir.deleteWithAllContents();
+    await this.s3CacheDir.delete({
+      mode: 'permanent',
+    });
   }
 }