@akaanakbaik/pterodactyl-gateway 0.3.0 → 0.4.0

package/README.md

@@ -1,97 +1,74 @@
 # Akadev Pterodactyl Gateway
 
-SDK TypeScript dan CLI sederhana untuk membantu project Node.js terhubung ke Pterodactyl Panel dengan lebih mudah.
+SDK TypeScript dan CLI untuk menghubungkan project Node.js ke Pterodactyl Panel dengan lebih mudah, aman, dan cepat.
 
-Package ini dibuat untuk kebutuhan bot reseller panel, dashboard custom, automation server, dan admin tools. Fokus v0.2.x adalah memperluas kontrol server dengan file manager, startup variables, network allocations, database manager, backup manager, schedules, dan probe read-only, sambil tetap menjaga smart create user/server, preview, dry run, error tutorial, raw request, test, dan pack check.
+Package ini cocok untuk bot reseller panel, dashboard custom, automation server, admin tools, dan project yang perlu membuat user/server Pterodactyl secara otomatis.
 
 Package ini bukan package resmi dari Pterodactyl dan tidak berafiliasi dengan Pterodactyl Software.
 
 ## Status
 
-Versi saat ini: `0.2.3`
-
-Fitur utama:
-
-- `createPtero()`
-- `createPtero.fromEnv()`
-- `connect()`
-- `health()`
-- `doctor()` dasar
-- `compatibility()` dasar
-- `raw.application` dan `raw.client`
-- `users.createSmart()`
-- `users.getOrCreate()`
-- `servers.previewCreate()`
-- `servers.createSmart()`
-- `servers.createFromPreset()`
-- `servers.createRaw()`
-- `server(identifier).start()`
-- `server(identifier).stop()`
-- `server(identifier).restart()`
-- `server(identifier).kill()`
-- `server(identifier).command()`
-- `server(identifier).resources()`
-- `server(identifier).probe()`
-- `server(identifier).files.list()`
-- `server(identifier).files.read()`
-- `server(identifier).files.write()`
-- `server(identifier).files.delete()`
-- `server(identifier).files.mkdir()`
-- `server(identifier).files.rename()`
-- `server(identifier).files.compress()`
-- `server(identifier).files.decompress()`
-- `server(identifier).files.json.read()`
-- `server(identifier).files.json.write()`
-- `server(identifier).startup.variables()`
-- `server(identifier).startup.set()`
-- `server(identifier).startup.setMany()`
-- `server(identifier).network.list()`
-- `server(identifier).network.assign()`
-- `server(identifier).network.setNote()`
-- `server(identifier).network.setPrimary()`
-- `server(identifier).network.delete()`
-- `server(identifier).databases.list()`
-- `server(identifier).databases.create()`
-- `server(identifier).databases.rotatePassword()`
-- `server(identifier).databases.delete()`
-- `server(identifier).backups.list()`
-- `server(identifier).backups.create()`
-- `server(identifier).backups.details()`
-- `server(identifier).backups.download()`
-- `server(identifier).backups.delete()`
-- `server(identifier).schedules.list()`
-- `server(identifier).schedules.create()`
-- `server(identifier).schedules.details()`
-- `server(identifier).schedules.update()`
-- `server(identifier).schedules.run()`
-- `server(identifier).schedules.delete()`
-- `server(identifier).schedules.tasks.create()`
-- `server(identifier).schedules.tasks.update()`
-- `server(identifier).schedules.tasks.delete()`
-- parser RAM, disk, CPU
-- error tutorial
-- CLI dasar `ptero-gateway`
-- `npm run verify`
-- `npm pack --dry-run`
-
-## Install lokal
+Versi saat ini: `0.3.0`
+
+Package npm publik:
 
 ```bash
-npm install @akadev/pterodactyl-gateway
+npm i @akaanakbaik/pterodactyl-gateway
 ```
 
-Untuk development dari GitHub:
+Install global CLI:
 
 ```bash
-git clone https://github.com/akaanakbaik/pterodactyl-gateway.git
-cd pterodactyl-gateway
-npm install
-npm run verify
+npm i -g @akaanakbaik/pterodactyl-gateway
 ```
 
+CLI tersedia sebagai:
+
+```bash
+ptero-gateway help
+ptg help
+```
+
+## Yang sudah terbukti di panel asli
+
+Fitur berikut sudah dites langsung pada panel Pterodactyl asli:
+
+- koneksi PTLA dan PTLC
+- `doctor`
+- `ids`
+- list admin users
+- list admin servers
+- create user
+- create server dengan dry-run
+- create server asli
+- auto docker image dari egg
+- auto startup dari egg
+- auto allocation
+- detail server admin
+- limits server admin
+- update limits server admin
+- suspend server
+- unsuspend server
+- probe read-only client server
+- summary server
+- resources realtime/polling
+- files list
+- files read
+- files write
+- startup/env read
+- startup/env set
+- network/ports read
+- backup list
+- backup detail
+- backup delete
+- schedules list
+- template `init-node-alive`
+- start/stop/restart/kill server
+- publish ke npm public registry
+
 ## Env
 
-Buat file `.env` di project kamu:
+Gunakan env berikut:
 
 ```env
 PTERO_DOMAIN=https://panel.example.com
@@ -101,14 +78,16 @@ PTERO_PTLC=ptlc_xxxxxxxxxxxxxxxxx
 
 Penjelasan:
 
-- `PTERO_DOMAIN` adalah domain panel Pterodactyl.
-- `PTERO_PTLA` adalah Application API Key untuk aksi admin seperti create user dan create server.
-- `PTERO_PTLC` adalah Client API Key untuk kontrol server seperti start, stop, command, resources, file manager, startup variables, network allocations, database manager, backups, schedules, dan realtime pada versi berikutnya.
+- `PTERO_DOMAIN`: domain panel Pterodactyl.
+- `PTERO_PTLA`: Application API Key untuk aksi admin seperti list user, create user, create server, update limits, suspend, unsuspend, dan reinstall.
+- `PTERO_PTLC`: Client API Key untuk kontrol server seperti resources, file manager, startup variables, ports, backups, schedules, dan power action.
 
-## Koneksi cepat
+Jangan hardcode API key ke source code.
+
+## Koneksi SDK
 
 ```ts
-import { createPtero } from "@akadev/pterodactyl-gateway";
+import { createPtero } from "@akaanakbaik/pterodactyl-gateway";
 
 const ptero = createPtero({
   domain: "https://panel.example.com",
@@ -120,30 +99,158 @@ const result = await ptero.connect();
 console.log(result);
 ```
 
-Atau dari env:
+Atau langsung dari env:
 
 ```ts
-import { createPtero } from "@akadev/pterodactyl-gateway";
+import { createPtero } from "@akaanakbaik/pterodactyl-gateway";
 
 const ptero = createPtero.fromEnv();
 await ptero.connect();
 ```
 
-## Create user smart
+## CLI cepat
+
+Cek koneksi:
+
+```bash
+ptero-gateway doctor
+ptero-gateway connect
+```
+
+Ambil ID node, nest, dan egg:
+
+```bash
+ptero-gateway ids
+ptero-gateway ids --nest 5
+```
+
+List server client:
+
+```bash
+ptero-gateway servers
+```
+
+List admin:
+
+```bash
+ptero-gateway admin users
+ptero-gateway admin servers
+```
+
+Create server dry-run:
+
+```bash
+ptero-gateway admin create-server \
+  --name "aka test" \
+  --email "user@example.com" \
+  --username "aka_test" \
+  --password "password aman" \
+  --node 1 \
+  --nest 5 \
+  --egg 18 \
+  --memory 1GB \
+  --disk 2GB \
+  --cpu 100% \
+  --databases 0 \
+  --allocations 1 \
+  --backups 0 \
+  --dry-run
+```
+
+Create server asli:
+
+```bash
+ptero-gateway admin create-server \
+  --name "aka test" \
+  --email "user@example.com" \
+  --username "aka_test" \
+  --password "password aman" \
+  --node 1 \
+  --nest 5 \
+  --egg 18 \
+  --memory 1GB \
+  --disk 2GB \
+  --cpu 100% \
+  --databases 0 \
+  --allocations 1 \
+  --backups 0 \
+  --yes
+```
+
+Detail dan limit server admin:
+
+```bash
+ptero-gateway admin server 5 detail
+ptero-gateway admin server 5 limits
+ptero-gateway admin server 5 update-limits --backups 1 --yes
+```
+
+Lifecycle admin:
 
-Field wajib:
+```bash
+ptero-gateway admin server 5 suspend --yes
+ptero-gateway admin server 5 unsuspend --yes
+ptero-gateway admin server 5 reinstall --yes
+```
 
-- `username`
-- `email`
-- `password`
-- `administrator`
+Probe dan summary server client:
 
-Jika `firstName` dan `lastName` kosong, nilainya otomatis memakai username.
+```bash
+ptero-gateway probe 311d56b7
+ptero-gateway server 311d56b7 summary
+ptero-gateway server 311d56b7 resources
+```
+
+File manager:
+
+```bash
+ptero-gateway server 311d56b7 files /
+ptero-gateway server 311d56b7 read /package.json
+ptero-gateway server 311d56b7 write /tmp/test.txt "halo" --yes
+ptero-gateway server 311d56b7 write /index.js "console.log('halo')" --yes --allow-any-path
+```
+
+Startup variables:
+
+```bash
+ptero-gateway server 311d56b7 env
+ptero-gateway server 311d56b7 set-env CMD_RUN "node index.js" --yes
+```
+
+Template server Node yang tetap hidup:
+
+```bash
+ptero-gateway server 311d56b7 stop --yes
+ptero-gateway server 311d56b7 init-node-alive --yes
+ptero-gateway server 311d56b7 start --yes
+ptero-gateway server 311d56b7 resources
+```
+
+Backup:
+
+```bash
+ptero-gateway server 311d56b7 backups
+ptero-gateway server 311d56b7 create-backup --name "before-update" --yes
+ptero-gateway server 311d56b7 backup <uuid>
+ptero-gateway server 311d56b7 delete-backup <uuid> --yes
+```
+
+Power control:
+
+```bash
+ptero-gateway server 311d56b7 start --yes
+ptero-gateway server 311d56b7 stop --yes
+ptero-gateway server 311d56b7 restart --yes
+ptero-gateway server 311d56b7 kill --yes
+ptero-gateway server 311d56b7 command "npm start" --yes
+```
+
+## Create user SDK
 
 ```ts
 const user = await ptero.users.createSmart({
-  username: "aka",
-  email: "aka@example.com",
+  username: "aka_test",
+  email: "user@example.com",
   password: "auto",
   administrator: "no"
 });
@@ -153,164 +260,87 @@ console.log(user);
 
 Jika `password: "auto"`, package membuat password aman dan mengembalikannya sekali pada response.
 
-## Create server smart
-
-Field wajib:
-
-- `name`
-- `email` atau `userId`
-- `description`
-- `nodeId`
-- `nestId`
-- `eggId`
-- `memory`
-- `disk`
-- `cpu`
-- `databases`
-- `allocations`
-- `backups`
-
-Yang otomatis:
-
-- docker image dari egg
-- startup command dari egg
-- environment variables dari egg
-- default allocation dari node
-- additional allocations sesuai allocation limit
-- swap default `0`
-- block IO default `500`
-- CPU pinning default kosong
-- OOM disabled default `false`
-- start on completion default `true`
+## Create server SDK
 
 ```ts
 const server = await ptero.servers.createSmart({
   name: "Bot WhatsApp Aka",
-  email: "aka@example.com",
+  email: "user@example.com",
+  username: "aka_test",
+  password: "password aman",
+  autoCreateUser: true,
   description: "Server bot WhatsApp untuk Aka",
   nodeId: 1,
   nestId: 5,
-  eggId: 15,
+  eggId: 18,
   specs: {
-    memory: "2GB",
-    disk: "5GB",
+    memory: "1GB",
+    disk: "2GB",
     cpu: "100%",
-    databases: 1,
+    databases: 0,
     allocations: 1,
-    backups: 1
+    backups: 0
   }
 });
 
 console.log(server);
 ```
 
-## Preview sebelum create
-
-Gunakan ini untuk melihat hasil auto-sync sebelum server benar-benar dibuat.
+## Preview dan dry-run SDK
 
 ```ts
-const preview = await ptero.servers.previewCreate({
-  name: "Bot WhatsApp Aka",
-  email: "aka@example.com",
-  description: "Server bot WhatsApp untuk Aka",
-  nodeId: 1,
-  nestId: 5,
-  eggId: 15,
-  specs: {
-    memory: "2GB",
-    disk: "5GB",
-    cpu: "100%",
-    databases: 1,
-    allocations: 1,
-    backups: 1
-  }
+const result = await ptero.servers.createSmart(input, {
+  dryRun: true
 });
 
-console.log(preview.payload);
-```
-
-## Probe read-only
-
-Probe dipakai untuk mengecek endpoint client server yang tersedia di panel tanpa membuat, mengedit, atau menghapus data.
-
-```ts
-const report = await ptero.server("abc12345").probe();
-console.log(report);
-```
-
-CLI:
-
-```bash
-ptero-gateway probe abc12345
+console.log(result.payload);
 ```
 
-## File manager
+## File manager SDK
 
 ```ts
-const server = ptero.server("abc12345");
+const server = ptero.server("311d56b7");
 
 const files = await server.files.list("/");
 const text = await server.files.read("/package.json");
-await server.files.write("/index.js", "console.log('halo')");
-await server.files.mkdir("/", "logs");
-await server.files.rename("/", [{ from: "old.js", to: "new.js" }]);
-await server.files.delete("/", ["old.js"]);
-await server.files.compress("/", ["src", "package.json"]);
-await server.files.decompress("/", "archive.tar.gz");
+await server.files.write("/index.js", "console.log('running')");
 
 const config = await server.files.json.read("/config.json");
 await server.files.json.write("/config.json", { ok: true });
 ```
 
-## Startup variables
+## Startup variables SDK
 
 ```ts
 const variables = await server.startup.variables();
-await server.startup.set("BOT_TOKEN", "token-baru");
+await server.startup.set("CMD_RUN", "node index.js");
 await server.startup.setMany({
   NODE_ENV: "production",
   STARTUP_FILE: "index.js"
 });
 ```
 
-## Network allocations
+## Network, database, backup, schedule SDK
 
 ```ts
-const allocations = await server.network.list();
+await server.network.list();
 await server.network.assign();
 await server.network.setNote(123, "API port");
 await server.network.setPrimary(123);
 await server.network.delete(123);
-```
 
-## Database manager
-
-```ts
-const databases = await server.databases.list();
+await server.databases.list();
 await server.databases.create({ database: "botdb" });
-await server.databases.create({ database: "botdb", remote: "%" });
 await server.databases.rotatePassword("database-id");
 await server.databases.delete("database-id");
-```
-
-## Backup manager
 
-```ts
-const backups = await server.backups.list();
-await server.backups.create({
-  name: "before-update",
-  ignored: ["node_modules"],
-  isLocked: false
-});
+await server.backups.list();
+await server.backups.create({ name: "before-update" });
 await server.backups.details("backup-id");
 await server.backups.download("backup-id");
 await server.backups.delete("backup-id");
-```
 
-## Schedules
-
-```ts
-const schedules = await server.schedules.list();
+await server.schedules.list();
 await server.schedules.create({
   name: "Daily restart",
   minute: "0",
@@ -319,74 +349,6 @@ await server.schedules.create({
   month: "*",
   dayOfWeek: "*"
 });
-await server.schedules.run(1);
-await server.schedules.tasks.create(1, {
-  action: "power",
-  payload: "restart",
-  timeOffset: 0
-});
-```
-
-## Dry run
-
-`dryRun` membuat payload final tanpa mengirim request create server.
-
-```ts
-const result = await ptero.servers.createSmart(input, {
-  dryRun: true
-});
-
-console.log(result.payload);
-```
-
-## Preset paket
-
-```ts
-const ptero = createPtero({
-  domain: "https://panel.example.com",
-  ptla: process.env.PTERO_PTLA,
-  ptlc: process.env.PTERO_PTLC,
-  presets: {
-    basic: {
-      memory: "2GB",
-      disk: "5GB",
-      cpu: "100%",
-      databases: 1,
-      allocations: 1,
-      backups: 1
-    }
-  }
-});
-
-await ptero.servers.createFromPreset("basic", {
-  name: "Bot Aka",
-  email: "aka@example.com",
-  description: "Paket Basic",
-  nodeId: 1,
-  nestId: 5,
-  eggId: 15
-});
-```
-
-## Kontrol server
-
-```ts
-const server = ptero.server("abc12345");
-
-await server.start();
-await server.stop();
-await server.restart();
-await server.kill();
-await server.command("npm start");
-const resources = await server.resources();
-```
-
-Command berbahaya seperti `rm -rf /` diblokir secara default.
-
-```ts
-await server.command("rm -rf /tmp/cache", {
-  allowDangerous: true
-});
 ```
 
 ## Raw request
@@ -396,27 +358,12 @@ Raw mode disediakan agar fitur baru atau panel fork tetap bisa dipakai.
 ```ts
 await ptero.raw.application.get("/users");
 await ptero.raw.application.post("/servers", payload);
-await ptero.raw.client.get("/servers/abc123/resources");
-await ptero.raw.client.post("/servers/abc123/command", {
+await ptero.raw.client.get("/servers/311d56b7/resources");
+await ptero.raw.client.post("/servers/311d56b7/command", {
   command: "npm start"
 });
 ```
 
-## CLI dasar
-
-Setelah build atau install global:
-
-```bash
-ptero-gateway doctor
-ptero-gateway connect
-ptero-gateway ids
-ptero-gateway ids --nest 5
-ptero-gateway probe abc12345
-ptero-gateway server abc123 resources
-ptero-gateway server abc123 restart
-ptero-gateway server abc123 command "npm start"
-```
-
 ## Testing di VPS Ubuntu
 
 ```bash
@@ -437,33 +384,32 @@ npm run verify
 - `npm run test:cli`
 - `npm run test:pack`
 
-Jika semua berhasil, package siap dilanjutkan ke fitur versi berikutnya.
+## Catatan keamanan
 
-## Roadmap ringkas
+- Jangan hardcode PTLA/PTLC di source code.
+- Semua aksi tulis/ubah via CLI wajib `--yes`.
+- Write file CLI default hanya boleh ke `/tmp`; untuk path lain wajib `--allow-any-path`.
+- Command berbahaya seperti `rm -rf /` diblokir oleh guard command.
+- Gunakan `--dry-run` sebelum create server asli.
+- Untuk delete server/user permanen, fitur sengaja belum dibuka di v0.3.0 dan akan dibuat dengan guard tambahan.
 
-### v0.1.x
-
-Core SDK, smart create user, smart create server, preview, dryRun, doctor dasar, CLI dasar, raw request, test, CI, pack check.
-
-### v0.2.x
-
-File manager, startup variables, database manager, backup manager, network allocations, schedules, cache, pagination, preset lebih matang.
+## Roadmap ringkas
 
-### v0.3.0
+### v0.3.x
 
-WebSocket console, stats realtime, polling fallback, audit event, event emitter.
+Perapihan docs, lifecycle aman, cleanup aman, validasi create server, dan command CLI yang lebih ramah pemula.
 
 ### v0.4.0
 
-CLI lebih lengkap: init, create-user wizard, create-server wizard, ids, server manager.
+Wizard CLI interaktif untuk create user/server, allocation helper, dan template project siap jalan.
 
 ### v0.5.0
 
-TUI atau GUI CLI terminal: dashboard interaktif, preview, create server, kontrol server, console viewer.
+TUI/GUI CLI terminal: dashboard interaktif, preview, create server, kontrol server, dan console viewer.
 
 ### v0.6.0
 
-Experimental nest/egg create/update/delete, import/export egg, compatibility adapter.
+Experimental nest/egg create/update/delete, import/export egg, dan compatibility adapter.
 
 ## Lisensi