feat: improve stuff

Author: prplwtf

docs/pages/about/changelog/beta-2024-11.md

@@ -16,12 +16,12 @@
 - `-info` values are now dimmed in supported terminal emulators.
 - `dbGet($table, $record)` now has an optional argument `$default` which will be returned if the database record is empty.
 - Migrations are now forced on extension installs. This change makes the [`developerForceMigrate` flag](?page=documentation/flags) obsolete.
-- Add `fs` modifier to `{root}` [placeholder](?page=documentation/placeholders).
 - Add `engine` [placeholder](?page=documentation/placeholders).
 - Broadcast `queue:restart` command on extension transaction.
 - Deprecated flags now provide warnings on extension transactions.
 - Add private version of ExtensionFS (`blueprint_private:<identifier>`) that is symlinked to the extension's private directory.
-- [`Components.yml`](?page=documentation/componentsyml) has a new "Global" scope.
+- [`Components.yml`](?page=documentation/componentsyml) has a new "Global" scope within "Dashboard".
+- Install, remove and export scripts now have access to the `$ENGINE` environment variable.
 
 <br/>
 
@@ -33,7 +33,7 @@
 <br/>
 
 #### Breaking Changes
-- [`Conf.yml`](?page=documentation/confyml) `requests_controllers` has been deprecated and will alias to `requests_app`. This does not change implementation and can be resolved by renaming the configuration option.
+- [`conf.yml`](?page=documentation/confyml) `requests_controllers` has been deprecated and will alias to `requests_app`. This does not change implementation and can be resolved by renaming the configuration option.
 - [BlueprintExtensionLibrary](?page=documentation/$blueprint)'s `dbGet($table, $record)` method now returns `null` when a value is empty, instead of returning an empty string.
 - [BlueprintExtensionLibrary](?page=documentation/$blueprint)'s **legacy variation** is being phased out. All `notify` and `file` methods now return false. This does not impact admin, client and console variations.
 - Resolved docs/implementation mismatch causing `requests_routers` to default to `application` instead of `web`. Backwards compatibility is not provided with this change.

docs/pages/documentation/componentsyml.md

@@ -31,10 +31,6 @@ Component file paths cannot escape the components directory **and** cannot end w
 The YAML file shown below contains all configuration options that are currently supported by Blueprint's components feature.
 
 ```yaml
-Global:
-  BeforeApplication: "" # beta-2024-11 and later
-  AfterApplication: "" # beta-2024-11 and later
-
 Navigation:
   NavigationBar: 
     BeforeNavigation: ""
@@ -49,14 +45,18 @@ Navigation:
   # - { Name: "", Path: "", Type: "account/server", Component: "", AdminOnly: "boolean" }
 
 Dashboard:
-  BeforeContent: ""
-  AfterContent: ""
-  ServerRow:
-    BeforeEntryName: ""
-    AfterEntryName: ""
-    BeforeEntryDescription: ""
-    AfterEntryDescription: ""
-    ResourceLimits: ""
+  Global:
+    BeforeSection: "" # beta-2024-11 and later
+    AfterSection: "" # beta-2024-11 and later
+  Serverlist:
+    BeforeContent: ""
+    AfterContent: ""
+    ServerRow:
+      BeforeEntryName: ""
+      AfterEntryName: ""
+      BeforeEntryDescription: ""
+      AfterEntryDescription: ""
+      ResourceLimits: ""
 
 Authentication:
   Container:

docs/pages/documentation/scripts.md

@@ -20,4 +20,49 @@ Scripts can **prevent extensions from being listed** on the [extension browse li
 - Updating extensions utilizing scripts must not break their modifications.
 - Scripts should use **environment variables** or [placeholders](?page=documentation/placeholders) for detecting the webserver folder.
 
-**Export scripts are free from (most of) these limitations** as they are specifically made to help the developer automate actions upon export. As long as you don't cause permanent damages through export scripts, you should be fine.
+**Export scripts are free from (most of) these limitations** as they are specifically made to help the developer automate actions upon export. As long as you don't cause permanent damages through export scripts, you should be fine.
+
+<br/>
+
+### **Environment variables**
+These variables can be used anywhere in your scripts and are automatically assigned the correct value by Blueprint.
+
+<!-- $ENGINE -->
+`$ENGINE`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">remove.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Codename of the engine currently handling the extension.
+
+<!-- $EXTENSION_IDENTIFIER -->
+`$EXTENSION_IDENTIFIER`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">remove.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Provides the extension's identifier.
+
+<!-- $EXTENSION_VERSION -->
+`$EXTENSION_VERSION`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">remove.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Provides the extension's version.
+
+<!-- $EXTENSION_TARGET -->
+`$EXTENSION_TARGET`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">remove.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Provides the extension's defined target version, not to be confused with the version the extension is currently being installed on.
+
+<!-- $PTERODACTYL_DIRECTORY -->
+`$PTERODACTYL_DIRECTORY`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">remove.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Path towards the Pterodactyl webserver folder, commonly `/var/www/pterodactyl`.
+
+<!-- $BLUEPRINT_VERSION -->
+`$BLUEPRINT_VERSION`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">remove.sh <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Blueprint version currently installed on the target panel.
+
+<!-- $BLUEPRINT_DEVELOPER -->
+`$BLUEPRINT_DEVELOPER`
+<span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">install.sh <i class="bi bi-check"></i></span> <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">remove.sh <i class="bi bi-x"></i></span> <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">export.sh <i class="bi bi-x"></i></span>\
+Either `true` or `false` depending on if the extension was installed through developer commands.
+
+<!-- $BLUEPRINT_EXPORT_DIRECTORY -->
+`$BLUEPRINT_EXPORT_DIRECTORY`
+<span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">install.sh <i class="bi bi-x"></i></span> <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">remove.sh <i class="bi bi-x"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">export.sh <i class="bi bi-check"></i></span>\
+Path towards the folder where Blueprint is building the extension package.