Merge pull request #146 from adrianocastro189/release/version-1.12.1

Release - v1.12.1
adrianocastro189 · Aug 21, 2024 · 7a17451 · 7a17451
2 parents 5c95fc8 + 4467df8
commit 7a17451
Show file tree

Hide file tree

Showing 37 changed files with 1,140 additions and 2,280 deletions.
diff --git a/documentation/docs/changelog.md b/documentation/docs/changelog.md
@@ -4,6 +4,12 @@ sidebar_position: 2
 
 # Changelog
 
+## 2024.08.21 - version 1.12.1
+
+* Update Docusaurus to version 3.5.2
+* Update [Import](library-structure/import) documentation for a better understanding 
+  of how to import the library into an addon
+
 ## 2024.08.20 - version 1.12.0
 
 * Add the [Interval:startImmediately()](resources/support/interval#usage) method
@@ -45,7 +51,7 @@ to indicate that their items lists are outdated and need to be refreshed
 functions at a specified interval in seconds
 * ~New Output method to make the player say something in the chat frame~ 
   (removed in v1.10.0)
-* New [view constants file](resources/views/constants) to store values that 
+* New [view constants file](resources/views/view-constants) to store values that 
 can be reused in multiple view classes and instances
 
 ## 2024.07.04 - version 1.7.0

diff --git a/documentation/docs/library-structure/import.md b/documentation/docs/library-structure/import.md
@@ -3,13 +3,17 @@ sidebar_position: 3
 title: Import
 ---
 
-When a new version of the library is [built](build), it's time to import it
-in the addon:
+When a new version of the library is [built](build), it can be downloaded and updated
+in an addon. The following steps describe how to import it for the first time. When
+updating, focus on steps **2** and **4**, by replacing the existing library file and
+the instantiation table name.
 
-1. Create a the `./lib/stormwind-library` directory in the addon root folder,
-so `lib` is at the same level as the addon `.toc` file
-2. Copy the `./dist/stormwind-library.lua` file from the library repository into
-the folder created above
-3. Update the addon `.toc` file by adding `lib\stormwind-library\stormwind-library.lua`
-4. Now, a library instance must be instantiated with `StormwindLibrary_vx_y_z.new()` where `x_y_z`
-is the current library version
+1. Create a `lib` directory in the addon root folder, so `lib` is at the same 
+   level as the addon `.toc` files
+1. Download `stormwind-library.lua` **OR** `stormwind-library.min.lua` from the
+   [most recent release](https://github.com/adrianocastro189/stormwind-library/releases)
+   into the folder created above
+1. Update the addon `.toc` file by adding
+   `lib\stormwind-library.lua` **OR** `lib\stormwind-library.min.lua`
+1. Now, a library instance must be instantiated with `StormwindLibrary_vx_y_z.new()` 
+   where `x_y_z` is the current library version
diff --git a/documentation/package-lock.json b/documentation/package-lock.json
diff --git a/documentation/package.json b/documentation/package.json
@@ -14,18 +14,18 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.1.1",
-    "@docusaurus/plugin-google-gtag": "^3.4.0",
-    "@docusaurus/preset-classic": "3.1.1",
+    "@docusaurus/core": "^3.5.2",
+    "@docusaurus/plugin-google-gtag": "^3.5.2",
+    "@docusaurus/preset-classic": "^3.5.2",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.1.1",
-    "@docusaurus/types": "3.1.1",
+    "@docusaurus/module-type-aliases": "^3.5.2",
+    "@docusaurus/types": "^3.5.2",
     "gh-pages": "^6.1.1"
   },
   "browserslist": {

diff --git a/documentation/static/lua-docs/classes/Commands.Command.html b/documentation/static/lua-docs/classes/Commands.Command.html
@@ -322,7 +322,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Commands.CommandsHandler.html b/documentation/static/lua-docs/classes/Commands.CommandsHandler.html
@@ -445,7 +445,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Core.Configuration.html b/documentation/static/lua-docs/classes/Core.Configuration.html
@@ -390,7 +390,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Core.Environment.html b/documentation/static/lua-docs/classes/Core.Environment.html
@@ -548,7 +548,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Core.Output.html b/documentation/static/lua-docs/classes/Core.Output.html
@@ -369,7 +369,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Facades.AbstractTooltip.html b/documentation/static/lua-docs/classes/Facades.AbstractTooltip.html
@@ -250,7 +250,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Facades.ClassicTooltip.html b/documentation/static/lua-docs/classes/Facades.ClassicTooltip.html
@@ -145,7 +145,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Facades.Events.html b/documentation/static/lua-docs/classes/Facades.Events.html
@@ -328,7 +328,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Facades.PetJournal.html b/documentation/static/lua-docs/classes/Facades.PetJournal.html
@@ -195,7 +195,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Facades.RetailTooltip.html b/documentation/static/lua-docs/classes/Facades.RetailTooltip.html
@@ -143,7 +143,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Facades.Target.html b/documentation/static/lua-docs/classes/Facades.Target.html
@@ -472,7 +472,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Factories.ItemFactory.html b/documentation/static/lua-docs/classes/Factories.ItemFactory.html
@@ -171,7 +171,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.Container.html b/documentation/static/lua-docs/classes/Models.Container.html
@@ -378,7 +378,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.Inventory.html b/documentation/static/lua-docs/classes/Models.Inventory.html
@@ -307,7 +307,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.Item.html b/documentation/static/lua-docs/classes/Models.Item.html
@@ -192,7 +192,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.Macro.html b/documentation/static/lua-docs/classes/Models.Macro.html
@@ -287,7 +287,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.Player.html b/documentation/static/lua-docs/classes/Models.Player.html
@@ -350,7 +350,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.RaidMarker.html b/documentation/static/lua-docs/classes/Models.RaidMarker.html
@@ -130,7 +130,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Models.Realm.html b/documentation/static/lua-docs/classes/Models.Realm.html
@@ -192,7 +192,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Support.Arr.html b/documentation/static/lua-docs/classes/Support.Arr.html
@@ -915,7 +915,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Support.Bool.html b/documentation/static/lua-docs/classes/Support.Bool.html
@@ -151,7 +151,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Support.Interval.html b/documentation/static/lua-docs/classes/Support.Interval.html
@@ -268,7 +268,7 @@ <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Support.Str.html b/documentation/static/lua-docs/classes/Support.Str.html
@@ -496,7 +496,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Views.MinimapIcon.html b/documentation/static/lua-docs/classes/Views.MinimapIcon.html
@@ -1038,7 +1038,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Views.Windows.Window.html b/documentation/static/lua-docs/classes/Views.Windows.Window.html
@@ -1081,7 +1081,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/classes/Views.Windows.WindowPage.html b/documentation/static/lua-docs/classes/Views.Windows.WindowPage.html
@@ -318,7 +318,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/index.html b/documentation/static/lua-docs/index.html
@@ -206,7 +206,7 @@ <h2>Classes</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/documentation/static/lua-docs/modules/stormwind-library.html b/documentation/static/lua-docs/modules/stormwind-library.html
@@ -196,7 +196,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-08-20 10:02:12 </i>
+<i style="float:right;">Last updated 2024-08-21 15:36:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/src/stormwind-library.lua b/src/stormwind-library.lua
@@ -1,4 +1,4 @@
--- Library version = '1.12.0'
+-- Library version = '1.12.1'
 
 -- import src/Core/CallbackLoader.lua