writetainer-lib 25.12.27-dev.7

package/.env

@@ -0,0 +1,29 @@
+# MongoDB
+MONGODB_URI="mongodb://192.168.1.141:27017/mcserver"
+JWT_SECRET="a7f3b9c2d8e4f6a1b0c5d7e9f2a3b8c4d6e1f0a9b7c3d5e8f4a2b6c9d0e7f1"
+
+# Local server path
+FOLDER_PATH="/mnt/nvme/minecraft/velocity-test"
+
+# Portainer
+PORTAINER_URL="https://192.168.1.141:2995"
+PORTAINER_API_KEY="ptr_f6aqnnlc7ytZV43nKhfyVnPJgtH6EJ62ljpWh1CokWs="
+
+# WebDAV Configuration (for file uploads)
+WEBDAV_URL="https://192.168.1.141:30001"
+WEBDAV_USERNAME=""
+WEBDAV_PASSWORD=""
+WEBDAV_SERVER_BASE_PATH="/minecraft/velocity-test"
+
+# Minecraft Server Path
+MINECRAFT_PATH="/mnt/nvme/minecraft/velocity-test"
+
+# Enable/disable REST API request logging
+LOG_API_REQUESTS=true
+
+# Global console logging control
+ENABLE_CONSOLE_LOGS=true
+DISABLE_CONSOLE_COLORS=false
+
+# Delete server folders
+DELETE_SERVER_FOLDERS=true # If false, server folders will be renamed instead of deleted

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 Erick Tran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# Writetainer-Lib
+
+A Portainer API accessibility library for Node.js, written in TypeScript. This library provides a convenient wrapper around the Portainer API, allowing you to easily interact with your Portainer instance to manage environments, stacks, and containers.
+
+## Features
+
+- **Authentication**: Easy authentication using Portainer API tokens.
+- **Environment Management**: Fetch details about your Portainer environments (endpoints).
+- **Stack Management**: Retrieve information about your stacks.
+- **Container Management**: List containers within an environment (proxies the Docker API).
+- **TypeScript Support**: Fully typed interfaces for better development experience.
+
+## Installation
+
+```bash
+npm install writetainer-lib
+```
+
+## Usage
+
+### Initialization
+
+First, import the `PortainerApiClient` and initialize it with your Portainer URL and API Token.
+
+```typescript
+import { PortainerApiClient } from 'writetainer-lib';
+
+const portainerUrl = 'https://your-portainer-instance.com';
+const apiToken = 'your-api-token';
+
+const client = new PortainerApiClient(portainerUrl, apiToken);
+```
+
+You can also specify a default environment ID during initialization:
+
+```typescript
+const client = new PortainerApiClient(portainerUrl, apiToken, 1);
+```
+
+If no environment ID is provided, the client will attempt to fetch the first available environment ID automatically.
+
+### Examples
+
+#### Get All Environments
+
+```typescript
+const environments = await client.getEnvironments();
+console.log(environments);
+```
+
+#### Get Stacks
+
+```typescript
+const stacks = await client.getStacks();
+console.log(stacks);
+```
+
+#### Get Containers
+
+Fetch all containers (running and stopped) for the default environment.
+
+```typescript
+const containers = await client.getContainers(true);
+console.log(containers);
+```
+
+#### Test Connection
+
+```typescript
+const isConnected = await client.testConnection();
+if (isConnected) {
+    console.log('Connected to Portainer!');
+}
+```
+
+## API Reference
+
+### `PortainerApiClient`
+
+#### Constructor
+`new PortainerApiClient(portainerUrl: string, apiToken: string, environmentId?: number | null)`
+
+#### Methods
+
+- `getEnvironments(): Promise<PortainerEnvironment[]>`
+  - Fetches a list of all Portainer environments.
+
+- `getEnvironment(environmentId: number): Promise<PortainerEnvironment>`
+  - Fetches details of a specific environment.
+
+- `getStacks(): Promise<PortainerStack[]>`
+  - Fetches a list of all stacks.
+
+- `getContainers(includeAll: boolean): Promise<PortainerContainer[] | undefined>`
+  - Fetches a list of containers for the current environment.
+  - `includeAll`: Set to `true` to include stopped containers.
+
+- `testConnection(): Promise<boolean>`
+  - Tests the connection to the Portainer API.
+
+- `DefaultEnvironmentId` (Getter/Setter)
+  - Get or set the default environment ID used for container operations.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "writetainer-lib",
+  "version": "25.12.27-dev.7",
+  "description": "a portainer api accessibility library",
+  "homepage": "https://github.com/enVId-tech/Writetainer-Lib#readme",
+  "bugs": {
+    "url": "https://github.com/enVId-tech/Writetainer-Lib/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/enVId-tech/Writetainer-Lib.git"
+  },
+  "license": "MIT",
+  "author": "envid-tech",
+  "main": "index.js",
+  "scripts": {
+    "test": "vitest",
+    "build": "tsc",
+    "ncu": "npx npm-check-updates -u && npm install"
+  },
+  "dependencies": {
+    "axios": "^1.13.2",
+    "debug": "^4.4.3",
+    "dotenv": "^17.2.3",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@types/debug": "^4.1.12",
+    "@types/node": "^25.0.3",
+    "vitest": "^4.0.16"
+  },
+  "type": "module"
+}