chore(release): prepare for 0.12.0-beta

Author: theboxer

CHANGELOG.md

@@ -2,6 +2,105 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.12.0-beta - 2025-04-28
+
+### 🚀 Features
+
+- Default global.text.model system setting to gpt-4o-mini ([6b54015](https://github.com/modxcms/modAI/commit/6b54015e27897474cbba859fded1413027e2b585))
+- Add basic tools support ([5f22a3f](https://github.com/modxcms/modAI/commit/5f22a3f5d4dec278e2e09364eefd74b5505e8fde))
+- Add base model to configure agents and store conversations (#15) ([2718b51](https://github.com/modxcms/modAI/commit/2718b5149a855d9b67f8e4e07f640d227bd99b18))
+- Add usage data to the service parsers ([18fa71b](https://github.com/modxcms/modAI/commit/18fa71b183440df36ff5df4b44bc7bc389f3a9dd))
+- Separate attachments and contexts ([400d6f2](https://github.com/modxcms/modAI/commit/400d6f251b37d26778652f61718c8874ff4d8543))
+- Add tool support via DB ([8d49728](https://github.com/modxcms/modAI/commit/8d497285b1c0c301caccbe9f8e87d604b2003b88))
+- Agent prompt & agent selector ([6ca5545](https://github.com/modxcms/modAI/commit/6ca554504c18ccab8b14ec6a4c1d913b189a2f8e))
+- Add support for context providers ([8a83bbf](https://github.com/modxcms/modAI/commit/8a83bbfceaa193f452b1e4a2c983cc53d599bdfe))
+- Add support to override model in an agent ([e8a9cf2](https://github.com/modxcms/modAI/commit/e8a9cf23e4b4b93bad0a94094cd3e0f5988c0cd9))
+- Add CMP to manage context providers ([bc3487b](https://github.com/modxcms/modAI/commit/bc3487b2f9f84e52265a62021003e031475b0f13))
+- Add CMP to manage tools ([f582428](https://github.com/modxcms/modAI/commit/f5824289deff016072b19d4bafd2e73213ae35c9))
+- Use yes/no renderer on boolean columns ([1478da8](https://github.com/modxcms/modAI/commit/1478da8155fa5aa9f56947d644e6d83abea4ce24))
+- Add CMP to manage agents ([ddb248d](https://github.com/modxcms/modAI/commit/ddb248d3cdab63b1d5b9a1d046c7d45d4c411574))
+- Ui to select agent ([0bf2149](https://github.com/modxcms/modAI/commit/0bf2149830e29ddf2e2b0a6cf1acfdfa9b915604))
+- Add basic modx tools ([30b26b1](https://github.com/modxcms/modAI/commit/30b26b1cb42c80d1781eb750989988f6b12e4936))
+- Add markdown parser for assistant messages ([f6d7966](https://github.com/modxcms/modAI/commit/f6d79667b37c8bc48624aaf496d35980887b4098))
+- Allow html in makrdown content ([021584f](https://github.com/modxcms/modAI/commit/021584fe495189a4a5289ca6674d5915f8c8d385))
+- Persist selected agent ([bbbb50b](https://github.com/modxcms/modAI/commit/bbbb50bb0724f0ffebf487b798712ad94a73ede6))
+- Add search adn better triggers to agent/tools/cps combos ([4fa8011](https://github.com/modxcms/modAI/commit/4fa8011b7e9e764c78bb26d637934c305fb62c7a))
+- Add advanced config to the agent ([2902da4](https://github.com/modxcms/modAI/commit/2902da433b5ae0360ad03b430c91e15bdf15280c))
+- Add support for openrouter.ai ([08c2fd9](https://github.com/modxcms/modAI/commit/08c2fd9d369027659537ed4c1ae232b641b2ef58))
+- Add model info to the response msg ([6280e64](https://github.com/modxcms/modAI/commit/6280e6464dfb761a1616194c868cc611c169131f))
+- Add ACLs for client & backend ([489ee77](https://github.com/modxcms/modAI/commit/489ee77a28dea596a49dfdeeb638c2ece52a00a6))
+- Add permissions check to tools ([74d2337](https://github.com/modxcms/modAI/commit/74d2337daea7dbd527c68d63a1a55f76e4e3c59c))
+- Add user groups permissions to agents ([4916dd0](https://github.com/modxcms/modAI/commit/4916dd067e36b2e9e4aee25c9babb1ea7a558611))
+- Improve scrolling for new messages ([766b794](https://github.com/modxcms/modAI/commit/766b794535e33cdf2124b7223a464adef2613163))
+- Add global modAI button with IndexedDB as persist layer ([b1c015f](https://github.com/modxcms/modAI/commit/b1c015f86c31cad6c98f66d43b883206d014560b))
+- Use bot icon for the global button ([03b8365](https://github.com/modxcms/modAI/commit/03b8365b255eae5db5b1032db682e1ad7692278a))
+- Add an option to index elements into vector db ([a2d5cbb](https://github.com/modxcms/modAI/commit/a2d5cbb6c793be79db6808e2903098f9d32093b0))
+- Make sure user has file_create permission and save policy on source when downloading an image ([1e71d3c](https://github.com/modxcms/modAI/commit/1e71d3cfe67825cfaa28cab462922c1195a65b9c))
+- Allow to override path in download image endpoint ([f29a942](https://github.com/modxcms/modAI/commit/f29a9428039c71a8aa9ef734983b05d5d7a316eb))
+- Add indexing script ([33c7dad](https://github.com/modxcms/modAI/commit/33c7dad532ed788f600b6d356826a6c8a7217e05))
+- Hide agent select button if no agents are available ([d1d6300](https://github.com/modxcms/modAI/commit/d1d630018d14eb2aa2910d1506029c9a7f9947f4))
+- Update openai API to use developer instead of system, max_completion_tokens instead of max_tokens and add an ability to disable temperature ([8fe8444](https://github.com/modxcms/modAI/commit/8fe84444fa1ac94cce3d01f5cd801db6f88174a3))
+- Renderer for selection context ([8f28184](https://github.com/modxcms/modAI/commit/8f2818475ebf6ca0374189195eee8cbcb9eef650))
+- Add tooltip to the agent selector ([7c9ebcb](https://github.com/modxcms/modAI/commit/7c9ebcb00f9bc34c76911f266e7dd8be1ae7d272))
+- Add title to the global button ([0263cd5](https://github.com/modxcms/modAI/commit/0263cd5476a90505107fefc313139c69899f5ecd))
+- Accept json encoded list of provider/tool classes ([5c3631b](https://github.com/modxcms/modAI/commit/5c3631b9a9f9436d85c8f70cb3e95c91b55a901f))
+- Rename tool's description to prompt and add internal description to tools & context providers ([97590df](https://github.com/modxcms/modAI/commit/97590dfd49ee882560ef52994a8565e89cc9e76d))
+- Allow to customize tool's prompt ([3bcb3d2](https://github.com/modxcms/modAI/commit/3bcb3d27304f533ce126e96e0a0cb4cad73f40d3))
+- Add a seed script ([8365ef6](https://github.com/modxcms/modAI/commit/8365ef63b0f41ec9712a03a89049dde4bf74e16a))
+- Add description to the prompt & description fields ([f28031d](https://github.com/modxcms/modAI/commit/f28031d6d46b0201673976192132a0cef2d3db3d))
+- Improve chat scrolling to show max 3 lines of last user message ([f2582db](https://github.com/modxcms/modAI/commit/f2582db0b1331bfb3cfdae32fa49104d305f13ee))
+- Add EditChunk and EditTemplate tools ([6e4c49b](https://github.com/modxcms/modAI/commit/6e4c49be9b1e419bb7334a9653e26f3873c89a5f))
+- Adjust image endpoint to support the new gpt-image-1 model ([3761cc1](https://github.com/modxcms/modAI/commit/3761cc154f2f933f130cc79d4982e9acb28cd4ba))
+- Make the modal resizable ([b7dca8c](https://github.com/modxcms/modAI/commit/b7dca8c4094019436b44b919cef7c833189b3fd1))
+- Add support for multipart/form-data endpoints like editing an image from openai ([e5804df](https://github.com/modxcms/modAI/commit/e5804df93244c9acc066875156cc05b177cdd36a))
+- Add maximize/minimize button to the header ([f73c1f5](https://github.com/modxcms/modAI/commit/f73c1f5edb97ef228ccb4db5f0a1a8819ba09ff6))
+- Store modal's position to the local storage ([9f4546d](https://github.com/modxcms/modAI/commit/9f4546d36e257cb2cec84ec63e64979c7b058ed1))
+- Define default font ([7323daf](https://github.com/modxcms/modAI/commit/7323daf3cbbcc54a6c88feb0b7c11859a17762da))
+
+### 🐛 Bug Fixes
+
+- Remove modx dependency from composer.json ([77c06bf](https://github.com/modxcms/modAI/commit/77c06bf9c177aafc6f68da7db740ecd3954a46ec))
+- Add default usage stats for streaming ([b5fd29a](https://github.com/modxcms/modAI/commit/b5fd29a7a0b582b7a6f73362edc6ba1b0447ce74))
+- Reenable pinecone config ([9ef6dd1](https://github.com/modxcms/modAI/commit/9ef6dd1d31a08debb82f10c6863db9fe80ab959c))
+- Create/update/delete agents ([78d82eb](https://github.com/modxcms/modAI/commit/78d82ebc14289f4e0bc6642fb486ec55d6ad57e4))
+- Correct typo in agent prompt description ([4241ada](https://github.com/modxcms/modAI/commit/4241ada31a1fe74d4e33339c6ae8f96c7c8a82a7))
+- Dispatch input event when setting value to the textarea ([6830a6a](https://github.com/modxcms/modAI/commit/6830a6ac643a1fdb19f814c7eeb8c8ae37654064))
+- Dealy shadow's onload by 1ms to fix occasion no-scroll on first open ([88c1eef](https://github.com/modxcms/modAI/commit/88c1eef7c77771e792802e731869d04a2d1eb17b))
+- Prevent error saving duplicate templates and chunks ([2801e3d](https://github.com/modxcms/modAI/commit/2801e3df92a1f7814b7137416afaf39f7f4a8ca5))
+- Correct prompt description to refer to editing a chunk instead of creating one ([f0efe4b](https://github.com/modxcms/modAI/commit/f0efe4bfcc7f5927f009a7b9f64f98e7033d29f8))
+- Enforce strict array typing for runTool method arguments ([4958e1a](https://github.com/modxcms/modAI/commit/4958e1a71967fc3bb28fa517cdea6f1063ce120a))
+- Add missing lexicons ([c17204d](https://github.com/modxcms/modAI/commit/c17204d18738b97e01e180f7eef440ab4cdd8ce0))
+
+### 🚜 Refactor
+
+- Refactor service parsers and streaming handlers ([4c13dc3](https://github.com/modxcms/modAI/commit/4c13dc33bfb493b42073bea3db28defd962167d3))
+- Improve descriptions and behavior for consistency ([8e22bf3](https://github.com/modxcms/modAI/commit/8e22bf3074a84d8ae812b4acc754a31265ad1dcc))
+- Update parameter 'parameters' to 'arguments' for consistency with ToolInterface ([09a8734](https://github.com/modxcms/modAI/commit/09a8734eb938422ce78959613434969ebcd840b4))
+
+### 📚 Documentation
+
+- Adjust setting names ([248ab85](https://github.com/modxcms/modAI/commit/248ab85c4399d06bb786ca77c24c22b52d201445))
+- Improve docs ([478b1cd](https://github.com/modxcms/modAI/commit/478b1cd0221d4ed5469a77837c55130af63791a8))
+- Admin ([a2121c3](https://github.com/modxcms/modAI/commit/a2121c39d58c671105c2df2bcd40d5a734d35974))
+- Add tool's prompt ([1ca1a92](https://github.com/modxcms/modAI/commit/1ca1a927e66d023d7c2ebd83ddb55a33416fb3da))
+
+### ⚙️ Miscellaneous Tasks
+
+- Fix commit links in the changelog ([1a58beb](https://github.com/modxcms/modAI/commit/1a58beb7a13ba4e10ddb81d6403e9f7385c7e711))
+- Apply phpcs fixes ([112d5bc](https://github.com/modxcms/modAI/commit/112d5bce191cd8c4591c7ba9e1cd29662a7d1989))
+- Add tables to build ([57dc306](https://github.com/modxcms/modAI/commit/57dc306c82ecb0dee901c7323923f9310cffd55f))
+- Use lexicons for error message ([6eec864](https://github.com/modxcms/modAI/commit/6eec86415360aed462fad7037a2a4e064245aacf))
+- Remove unused scripts ([70e87b5](https://github.com/modxcms/modAI/commit/70e87b594b52285d33a4eeb84526a347b8003e13))
+- Refactor system settings and AI services ([15bb714](https://github.com/modxcms/modAI/commit/15bb71408dfe2a6624900046f86c9209cffd909c))
+- Refactor plugins ([9e0df6c](https://github.com/modxcms/modAI/commit/9e0df6ccf7540d9ade3e4021fa81c1f348c961c8))
+- Move APIException under Exceptions namespace ([03ce874](https://github.com/modxcms/modAI/commit/03ce874627e9d3b4acdc1fe20a6384a586bd0ab6))
+- Move global.d.ts under @types dir ([50cdaf9](https://github.com/modxcms/modAI/commit/50cdaf9839bea262e42ee89fb6382255384dc484))
+- Mark the mgr namespace in executor as deprecated, will be removed in major release ([c8888cb](https://github.com/modxcms/modAI/commit/c8888cb55e3a837a6d1c5262a0625ba6c55759dc))
+- Separate type imports ([95c697c](https://github.com/modxcms/modAI/commit/95c697cbb28d373b05732c2ddf90f7b0616e498d))
+- Remove test seed script & delete category tool ([26ab011](https://github.com/modxcms/modAI/commit/26ab011ba399c4ffbb367f6f05de9278502b9da1))
+- Add Debug helper class ([10495e7](https://github.com/modxcms/modAI/commit/10495e7ef1d66ebaa6b4accfa8edcc038c24ba8c))
+- Add EditChunk and EditTemplate tools to seed script ([eb70146](https://github.com/modxcms/modAI/commit/eb70146cc105af80c686eec1eb86bc909c3aa85e))
+
 ## 0.11.0-pl - 2025-03-20
 
 ### 🚀 Features
@@ -62,7 +161,7 @@ All notable changes to this project will be documented in this file.
 - Add fullUrl to the return array in the image download processor ([5869b40](https://github.com/modxcms/modAI/commit/5869b40ceb987d55b96635bdd399bedf7d3cc008))
 - Create JS API for modAI processors ([b2b4b78](https://github.com/modxcms/modAI/commit/b2b4b7892e880242f133f9e0741c946a1647f607))
 - Simplify the JS API ([dee659e](https://github.com/modxcms/modAI/commit/dee659edef8e0b58a4d06dee7cafe2ce97228fa0))
-- Add style option for image models ([61371c3](https://github.com/modxcms/modAI/commit/61371c342f6c3ef93e5362556b378f14a6e9c2d1)), resolves #11
+- Add style option for image models ([61371c3](https://github.com/modxcms/modAI/commit/61371c342f6c3ef93e5362556b378f14a6e9c2d1))
 - Add support for passing custom options to each model ([ff25a6f](https://github.com/modxcms/modAI/commit/ff25a6f5d70d32fd094bf202151b223e97ae44a6))
 - Merge all system prompts to a single message ([314c9ca](https://github.com/modxcms/modAI/commit/314c9cac2c4b1ab94bf7f7cc9ac84fd618cf1a0b))
 - Add support for client side streaming (chatgpt & gemini) ([0dc2c68](https://github.com/modxcms/modAI/commit/0dc2c68c4110dbb27285c7d8c0aefdcde5734713))
@@ -123,7 +222,7 @@ All notable changes to this project will be documented in this file.
 
 - Add missing import ([90a2f66](https://github.com/modxcms/modAI/commit/90a2f66eab46db6b751a9c955d0ae6526fb19d18))
 - Update assetsUrl path ([68780fa](https://github.com/modxcms/modAI/commit/68780fa50b99aa46ce89e3bc4696620a63e43c7c))
-- Fix saving altTag ([9e62f83](https://github.com/modxcms/modAI/commit/9e62f839b253cb3c374e12f200e9ef146380dd89)), Resolves #1
+- Fix saving altTag ([9e62f83](https://github.com/modxcms/modAI/commit/9e62f839b253cb3c374e12f200e9ef146380dd89))
 - Fix name of global base prompt ([a68bf91](https://github.com/modxcms/modAI/commit/a68bf91862e3ac6f9c4e3678b2848f7448577ae4))
 - Fix global base prompt in free text ([faaf61d](https://github.com/modxcms/modAI/commit/faaf61dd172b4d8e674dabbc7d24ae8be41a92ac))
 - Fix grabbing chatgpt key ([a173a55](https://github.com/modxcms/modAI/commit/a173a552b94a4158c621fa47c2d48a61efbf5d1d))

_build/gpm.yaml

@@ -1,5 +1,5 @@
 name: modAI
-version: 0.12.0-alpha5
+version: 0.12.0-beta
 lowCaseName: modai
 namespace: modAI
 author: 'John Peca'
@@ -197,6 +197,8 @@ systemSettings:
     value: ''
 
 build:
+  readme: core/components/modai/docs/README.md
+  changelog: core/components/modai/docs/CHANGELOG.md
   scriptsBefore:
     - custom_events.gpm.php
     - acls.gpm.php

cliff.toml

@@ -19,9 +19,6 @@ body = """
     ### {{ group | striptags | trim | upper_first }}
     {% for commit in commits %}
         - {{ commit.message | split(pat="\n") | first | upper_first | trim }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/modxcms/modAI/commit/{{ commit.id }}))\
-          {% for footer in commit.footers -%}
-            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
-          {% endfor %}\
     {% endfor %}
 {% endfor %}\n
 """

cliff_pkg.toml

@@ -0,0 +1,59 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+This is a shortened version, [view full Changelog here](https://github.com/modxcms/modAI/blob/main/CHANGELOG.md).\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## Unreleased
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | split(pat="\n") | first | upper_first | trim }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/modxcms/modAI/commit/{{ commit.id }}))\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = false
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->Features" },
+  { message = "^fix", group = "<!-- 1 -->Bug Fixes" },
+  { message = "^doc", skip = true },
+  { message = "^perf", skip = true },
+  { message = "^refactor", skip = true },
+  { message = "^style", skip = true },
+  { message = "^test", skip = true },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", skip = true },
+  { body = ".*security", group = "<!-- 8 -->Security" },
+  { message = "^revert", skip = true },
+  { message = ".*", skip = true },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"