From 14d75be0de44cce198efb05a50ecf2418efba96d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?marcin=20miko=C5=82ajczak?= <git@mkljczk.pl>
Date: Tue, 29 Oct 2024 22:07:57 +0100
Subject: [PATCH] pl-api: improve docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
---
 .github/workflows/pl-fe.yaml       | 2 +-
 packages/pl-api/package.json       | 1 +
 packages/pl-api/typedoc.config.mjs | 9 +++++++++
 packages/pl-api/typedoc.js         | 5 -----
 packages/pl-api/yarn.lock          | 5 +++++
 5 files changed, 16 insertions(+), 6 deletions(-)
 create mode 100644 packages/pl-api/typedoc.config.mjs
 delete mode 100644 packages/pl-api/typedoc.js

diff --git a/.github/workflows/pl-fe.yaml b/.github/workflows/pl-fe.yaml
index 2bfc84421..f0333f583 100644
--- a/.github/workflows/pl-fe.yaml
+++ b/.github/workflows/pl-fe.yaml
@@ -65,7 +65,7 @@ jobs:
 
     - name: Build pl-api documentation
       working-directory: ./packages/pl-api
-      run: npx typedoc lib/main.ts
+      run: npx typedoc
 
     - name: Copy pl-api documentation
       working-directory: ./packages/pl-api
diff --git a/packages/pl-api/package.json b/packages/pl-api/package.json
index 6077e81e2..aa8c0c3fc 100644
--- a/packages/pl-api/package.json
+++ b/packages/pl-api/package.json
@@ -32,6 +32,7 @@
     "eslint-plugin-promise": "^6.0.0",
     "typedoc": "^0.26.10",
     "typedoc-material-theme": "^1.1.0",
+    "typedoc-plugin-valibot": "^1.0.0",
     "typescript": "^5.6.2",
     "vite": "^5.4.8",
     "vite-plugin-dts": "^4.2.3"
diff --git a/packages/pl-api/typedoc.config.mjs b/packages/pl-api/typedoc.config.mjs
new file mode 100644
index 000000000..3bf38985d
--- /dev/null
+++ b/packages/pl-api/typedoc.config.mjs
@@ -0,0 +1,9 @@
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+
+const config = {
+  entryPoints: ['./lib/main.ts'],
+  plugin: ['typedoc-material-theme', 'typedoc-plugin-valibot'],
+  themeColor: '#d80482',
+};
+
+export default config;
diff --git a/packages/pl-api/typedoc.js b/packages/pl-api/typedoc.js
deleted file mode 100644
index fcc83623f..000000000
--- a/packages/pl-api/typedoc.js
+++ /dev/null
@@ -1,5 +0,0 @@
-export default {
-  plugin: ['typedoc-material-theme'],
-  themeColor: '#d80482',
-};
-
diff --git a/packages/pl-api/yarn.lock b/packages/pl-api/yarn.lock
index 61dc288f1..2d51fdce1 100644
--- a/packages/pl-api/yarn.lock
+++ b/packages/pl-api/yarn.lock
@@ -2758,6 +2758,11 @@ typedoc-material-theme@^1.1.0:
   dependencies:
     "@material/material-color-utilities" "^0.2.7"
 
+typedoc-plugin-valibot@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/typedoc-plugin-valibot/-/typedoc-plugin-valibot-1.0.0.tgz#9a7e586d993f5e6c9efe60ab12724e4fb24f7efe"
+  integrity sha512-3LJSPc/aAKvxsfJx3/qgI1HBJvh4JNmtQYzcbxiQrVdiloIQwh4g0KtwvHV9CCl6gAnDxdnFMdE5gbhne2wXuw==
+
 typedoc@^0.26.10:
   version "0.26.10"
   resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.26.10.tgz#d372f171dc2c4458cbac6c473be9591042ab781d"