1.1.0

changelog.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 2024-12-18 - 1.1.0 - feat(core)
+Update package dependencies and improve API integration.
+
+- Updated devDependencies and dependencies in package.json.
+- Integrated new package @serve.zone/api.
+- Updated identityArg in SparkLocalConfig for userHomeDir kvStore.
+
+## 2024-06-13 - 1.0.85 to 1.0.90 - Core Updates
+Routine updates and fixes to core functionality.
+
+- Updated core component throughout versions for enhanced stability
+- Incremental improvements applied on versions 1.0.85 to 1.0.90
+
+## 2024-05-08 - 1.0.82 to 1.0.85 - Core Enhancements
+Consistent updates made to improve core operations.
+
+- Updates focused on core functionality for improved performance
+- Series of updates applied from versions 1.0.82 to 1.0.85

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "losslessone/services/initzone",
       "gitrepo": "spark",
-      "description": "A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the Servezone infrastructure.",
+      "description": "A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the Servezone infrastructure and used by @serve.zone/cloudly as a cluster node server system manager.",
       "npmPackagename": "@losslessone_private/spark",
       "license": "MIT",
       "projectDomain": "https://lossless.one",
@@ -24,7 +24,11 @@
         "task scheduling",
         "CLI",
         "logging",
-        "server maintenance"
+        "server maintenance",
+        "serve.zone",
+        "cluster management",
+        "system manager",
+        "server configuration"
       ]
     }
   },
@@ -32,5 +36,8 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "private",
     "npmRegistryUrl": "verdaccio.lossless.one"
+  },
+  "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": "@serve.zone/spark",
-  "version": "1.0.88",
+  "version": "1.1.0",
   "private": false,
-  "description": "A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the Servezone infrastructure.",
+  "description": "A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the Servezone infrastructure and used by @serve.zone/cloudly as a cluster node server system manager.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "author": "Task Venture Capital GmbH",
@@ -16,29 +16,30 @@
     "spark": "./cli.js"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.80",
-    "@git.zone/tsrun": "^1.2.39",
+    "@git.zone/tsbuild": "^2.2.0",
+    "@git.zone/tsrun": "^1.3.3",
     "@git.zone/tstest": "^1.0.60",
-    "@push.rocks/tapbundle": "^5.0.4",
-    "@types/node": "20.14.2"
+    "@push.rocks/tapbundle": "^5.5.3",
+    "@types/node": "22.10.2"
   },
   "dependencies": {
-    "@apiclient.xyz/docker": "^1.2.2",
-    "@push.rocks/npmextra": "^5.0.17",
+    "@apiclient.xyz/docker": "^1.2.7",
+    "@push.rocks/npmextra": "^5.1.2",
     "@push.rocks/projectinfo": "^5.0.1",
-    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/qenv": "^6.1.0",
     "@push.rocks/smartcli": "^4.0.11",
     "@push.rocks/smartdaemon": "^2.0.3",
     "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartfile": "^11.0.20",
+    "@push.rocks/smartfile": "^11.0.23",
     "@push.rocks/smartjson": "^5.0.20",
     "@push.rocks/smartlog": "^3.0.7",
     "@push.rocks/smartlog-destination-local": "^9.0.0",
     "@push.rocks/smartpath": "^5.0.5",
-    "@push.rocks/smartshell": "^3.0.5",
+    "@push.rocks/smartshell": "^3.2.2",
     "@push.rocks/smartupdate": "^2.0.4",
     "@push.rocks/taskbuffer": "^3.0.10",
-    "@serve.zone/interfaces": "^1.0.74"
+    "@serve.zone/api": "^4.5.1",
+    "@serve.zone/interfaces": "^4.5.1"
   },
   "files": [
     "ts/**/*",
@@ -71,6 +72,10 @@
     "task scheduling",
     "CLI",
     "logging",
-    "server maintenance"
+    "server maintenance",
+    "serve.zone",
+    "cluster management",
+    "system manager",
+    "server configuration"
   ]
 }

readme.hints.md

@@ -1,2 +1,2 @@
-- this package is part of serve.zone
-- it is used to maintain and configure servers on the base OS level
+- make sure to mention that this package is part of serve.zone and **spark's main purpose** is the be used by @serve.zone/cloudly as a cluster node server system manager.
+- it is used to maintain and configure servers on the base OS level

readme.md

@@ -1,5 +1,5 @@
 # @serve.zone/spark
-A tool to maintain and configure servers on the base OS level for the Servezone infrastructure.
+A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the serve.zone infrastructure. It's mainly designed to be utilized by @serve.zone/cloudly as a cluster node server system manager, maintaining and configuring servers on the base OS level.
 
 ## Install
 To install `@serve.zone/spark`, run the following command in your terminal:
@@ -8,6 +8,8 @@ To install `@serve.zone/spark`, run the following command in your terminal:
 npm install @serve.zone/spark --save
 ```
 
+Ensure you have both Node.js and npm installed on your machine.
+
 ## Usage
 
 ### Getting Started
@@ -20,14 +22,14 @@ import { Spark } from '@serve.zone/spark';
 ```
 
 ### Initializing Spark
-Create an instance of the `Spark` class to start using Spark. This instance will serve as the main entry point for interacting with the Spark functionalities.
+Create an instance of the `Spark` class to start using Spark. This instance will serve as the main entry point for interacting with Spark functionalities.
 
 ```typescript
 const sparkInstance = new Spark();
 ```
 
 ### Running Spark as a Daemon
-To run Spark as a daemon, which is useful for maintaining and configuring servers on the base OS level, use the CLI feature bundled with Spark. This should ideally be handled outside of your code through a command-line terminal but can also be automated within your Node.js scripts if required.
+To run Spark as a daemon, which is useful for maintaining and configuring servers at the OS level, you can use the CLI feature bundled with Spark. This should ideally be handled outside of your code through a command-line terminal but can also be automated within your Node.js scripts if required.
 
 ```shell
 spark installdaemon
@@ -43,7 +45,7 @@ await sparkInstance.sparkUpdateManager.updateServices();
 ```
 
 ### Managing Configuration and Logging
-Spark allows for extensive configuration and logging customization. Use the `SparkLocalConfig` and logging features to tailor Spark's operation to your needs.
+Spark allows extensive configuration and logging customization. Use the `SparkLocalConfig` and logging features to tailor Spark's operation to your needs.
 
 ```typescript
 // Accessing the local configuration
@@ -56,7 +58,7 @@ logger.log('info', 'Custom log message');
 ```
 
 ### Advanced Usage
-`@serve.zone/spark` offers a suite of tools for detailed server and service management, including but not limited to task scheduling, daemon management, and service updates. Explore the `SparkTaskManager` for scheduling specific tasks, `SparkUpdateManager` for handling service updates, and `SparkLocalConfig` for configuration.
+`@serve.zone/spark` offers tools for detailed server and service management, including but not limited to task scheduling, daemon management, and service updates. Explore the `SparkTaskManager` for scheduling specific tasks, `SparkUpdateManager` for handling service updates, and `SparkLocalConfig` for configuration.
 
 ### Example: Scheduling Custom Tasks
 ```typescript
@@ -76,7 +78,7 @@ sparkInstance.sparkTaskManager.taskmanager.addAndScheduleTask(myTask, '* * * * *
 The example above creates a simple task that logs a message every second, demonstrating how to use Spark's task manager for custom scheduled tasks.
 
 ### Detailed Service Management
-For advanced configurations, including Docker and service management:
+For advanced configurations, including Docker and service management, you can utilize the following patterns:
 
 - Use `SparkUpdateManager` to handle Docker image updates, service creation, and management.
 - Access and modify Docker and service configurations through Spark's integration with configuration files and environment variables.
@@ -129,7 +131,7 @@ spark prune
 Stops and cleans up all Docker services (stacks, networks, secrets, etc.) and prunes the Docker system.
 
 ### Programmatic Daemon Management
-You can also manage the daemon programmatically as shown in the following examples:
+You can also manage the daemon programmatically:
 
 ```typescript
 import { SmartDaemon } from '@push.rocks/smartdaemon';
@@ -278,6 +280,21 @@ createDockerSecret();
 
 This example shows how to create a Docker secret using Spark's `SparkUpdateManager` class, ensuring that sensitive information is securely stored and managed.
 
-### Conclusion
-`@serve.zone/spark` is a comprehensive toolkit for orchestrating and managing server environments and Docker-based services. By leveraging its CLI and programmatic interfaces, you can automate and streamline server operations, configurations, updates, and task scheduling, ensuring your infrastructure is responsive, updated, and maintained efficiently.
-undefined
+## 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.

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@serve.zone/spark',
-  version: '1.0.88',
-  description: 'A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the Servezone infrastructure.'
+  version: '1.1.0',
+  description: 'A comprehensive tool for maintaining and configuring servers, integrating with Docker and supporting advanced task scheduling, targeted at the Servezone infrastructure and used by @serve.zone/cloudly as a cluster node server system manager.'
 }

ts/spark.classes.localconfig.ts

@@ -9,7 +9,7 @@ export class SparkLocalConfig {
     this.sparkRef = sparkRefArg;
     this.kvStore = new plugins.npmextra.KeyValueStore({
       typeArg: 'userHomeDir',
-      identityArg: 'spark',
+      identityArg: 'servezone_spark',
     });
   }
 }

ts/spark.plugins.ts

@@ -5,8 +5,9 @@ export { path };
 
 // @serve.zone scope
 import * as servezoneInterfaces from '@serve.zone/interfaces';
+import * as servezoneApi from '@serve.zone/api';
 
-export { servezoneInterfaces };
+export { servezoneInterfaces, servezoneApi };
 
 // @apiclient.xyz scope
 import * as docker from '@apiclient.xyz/docker';