fix(deps): update docusaurus monorepo to v3 (major)

docs/releases/3.0.0-beta.0.md

@@ -99,7 +99,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **legacy:** track_type_id should cast to int not text ([#2112](https://github.com/libretime/libretime/issues/2112))
 - **worker:** rewrite podcast download task
 - **shared:** load env from oneOf union schema
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.11.1
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.11.1
 - nginx depends on legacy in docker-compose ([#2147](https://github.com/libretime/libretime/issues/2147))
 - **playout:** remove shutdown_handler
 

docs/releases/3.1.0.md

@@ -63,20 +63,20 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **playout:** remove outdated liquidsoap code
 - **playout:** add types
 - **api:** allow single digit version for legacy schema
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.12.1
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.12.1
 - remove systemd ProtectHome feature ([#2243](https://github.com/libretime/libretime/issues/2243))
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.1 ([#2249](https://github.com/libretime/libretime/issues/2249))
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.13.1 ([#2249](https://github.com/libretime/libretime/issues/2249))
 - **worker:** replace deprecated cgi.parse_header
 - **installer:** install missing sudo
 - **installer:** set home and login when running as postgres
 - **legacy:** add log entry on task run ([#2316](https://github.com/libretime/libretime/issues/2316))
 - **legacy:** log errors on connect check failure ([#2317](https://github.com/libretime/libretime/issues/2317))
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.2
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.3
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.13.2
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.13.3
 - **legacy:** advanced search by track type id
 - **legacy:** move forked deps to the libretime namespace
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.14.4
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.14.5
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.14.4
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.14.5
 - **legacy:** ensure options is a dict during json encoding
 - **legacy:** don't use dict assignment on object ([#2384](https://github.com/libretime/libretime/issues/2384))
 - **playout:** quote escape strings in liquidsoap entrypoint
@@ -94,7 +94,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **playout:** prevent unbound variables
 - **playout:** use int for liquidsoap queues map
 - **shared:** return type confusion
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.15.2
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.15.2
 - **api:** explicit FileImportStatusEnum in schema
 - pin postgresql version in docker-compose
 - pin rabbitmq version in docker-compose
@@ -105,7 +105,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **installer:** bump setuptools to ~=67.3 ([#2387](https://github.com/libretime/libretime/issues/2387))
 - **playout:** use new api-client v1
 - **playout:** catch oserror in liquidsoap client
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.16.1 (main) ([#2490](https://github.com/libretime/libretime/issues/2490))
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.16.1 (main) ([#2490](https://github.com/libretime/libretime/issues/2490))
 - **api:** require django >=4.2.0,<4.3
 - **api:** upgrade psycopg to v3.1
 - **playout:** remove unused ecasound package ([#2496](https://github.com/libretime/libretime/issues/2496))
@@ -115,7 +115,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **legacy:** keep datatable settings between views ([#2519](https://github.com/libretime/libretime/issues/2519))
 - **api:** upgrade django code (pre-commit)
 - **analyzer:** remove unused python3 package
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.17.1 (main) ([#2556](https://github.com/libretime/libretime/issues/2556))
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.17.1 (main) ([#2556](https://github.com/libretime/libretime/issues/2556))
 
 ## :arrow_up: Upgrading
 

docusaurus.config.js → docusaurus.config.ts

@@ -1,10 +1,8 @@
-// @ts-check
-// Note: type annotations allow type checking and IDEs autocompletion
+import type { Config } from "@docusaurus/types";
+import type * as Preset from "@docusaurus/preset-classic";
+import vars from "./vars";
 
-const vars = require("./vars");
-
-/** @type {import('@docusaurus/types').Config} */
-const config = {
+const config: Config = {
   title: vars.title,
   tagline: vars.description,
   url: process.env.URL || vars.website,
@@ -40,8 +38,7 @@ const config = {
   presets: [
     [
       "classic",
-      /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
+      {
         docs: {
           path: process.env.DOCS_PATH || "./docs",
           sidebarPath: require.resolve("./sidebars.js"),
@@ -71,59 +68,57 @@ const config = {
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
         },
-      }),
+      } satisfies Preset.Options,
     ],
   ],
 
-  themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
-      navbar: {
-        title: vars.title,
-        logo: {
-          alt: "LibreTime tower",
-          src: "img/icon.svg",
+  themeConfig: {
+    navbar: {
+      title: vars.title,
+      logo: {
+        alt: "LibreTime tower",
+        src: "img/icon.svg",
+      },
+      items: [
+        {
+          label: "Docs",
+          to: "/docs",
+          position: "left",
+          type: "dropdown",
+          items: vars.doc.sections,
         },
-        items: [
-          {
-            label: "Docs",
-            to: "/docs",
-            position: "left",
-            type: "dropdown",
-            items: vars.doc.sections,
-          },
-          { label: "Contribute", to: "/docs/contribute", position: "left" },
-          { label: "Blog", to: "blog", position: "left" },
+        { label: "Contribute", to: "/docs/contribute", position: "left" },
+        { label: "Blog", to: "blog", position: "left" },
 
-          { ...vars.repository, position: "right" },
-          { ...vars.forum, position: "right" },
-          { ...vars.channel, position: "right" },
-          { type: "docsVersionDropdown", position: "right" },
-          // { type: "localeDropdown", position: "right" },
-        ],
-      },
-      footer: {
-        style: "dark",
-        links: [
-          {
-            title: "Docs",
-            items: vars.doc.sections,
-          },
-          {
-            title: "Community",
-            items: [vars.forum, vars.channel],
-          },
-          {
-            title: "More",
-            items: [vars.repository],
-          },
-        ],
-        copyright: `Code licensed under AGPLv3; docs licensed under GPLv2.`,
-      },
-      prism: {
-        additionalLanguages: ["apacheconf", "ini", "nginx"],
-      },
-    }),
+        { ...vars.repository, position: "right" },
+        { ...vars.forum, position: "right" },
+        { ...vars.channel, position: "right" },
+        { type: "docsVersionDropdown", position: "right" },
+        // { type: "localeDropdown", position: "right" },
+      ],
+    },
+    footer: {
+      style: "dark",
+      links: [
+        {
+          title: "Docs",
+          items: vars.doc.sections,
+        },
+        {
+          title: "Community",
+          items: [vars.forum, vars.channel],
+        },
+        {
+          title: "More",
+          items: [vars.repository],
+        },
+      ],
+      copyright: `Code licensed under AGPLv3; docs licensed under GPLv2.`,
+    },
+    prism: {
+      additionalLanguages: ["apacheconf", "ini", "nginx"],
+    },
+  } satisfies Preset.ThemeConfig,
 };
 
 module.exports = config;

package.json

@@ -15,24 +15,25 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@cmfcmf/docusaurus-search-local": "^1.0.0",
-    "@docusaurus/core": "^2.0.1",
-    "@docusaurus/plugin-client-redirects": "^2.0.1",
-    "@docusaurus/preset-classic": "^2.0.1",
-    "@mdx-js/react": "^1.6.21",
+    "@cmfcmf/docusaurus-search-local": "^1.1.0",
+    "@docusaurus/core": "^3.0.1",
+    "@docusaurus/plugin-client-redirects": "^3.0.1",
+    "@docusaurus/preset-classic": "^3.0.1",
+    "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
-    "mdx-mermaid": "^1.2.3",
-    "mermaid": "^10.0.0",
-    "prism-react-renderer": "^2.0.0",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "mdx-mermaid": "^2.0.0",
+    "mermaid": "^10.6.1",
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.0.1",
-    "@tsconfig/docusaurus": "^2.0.0",
-    "@types/node": "^20.0.0",
+    "@docusaurus/module-type-aliases": "^3.0.1",
+    "@docusaurus/tsconfig": "^3.0.1",
+    "@types/node": "^20.10.5",
+    "@types/react": "^18.2.45",
     "raw-loader": "^4.0.2",
-    "typescript": "^5.0.0"
+    "typescript": "^5.3.3"
   },
   "browserslist": {
     "production": [

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@tsconfig/docusaurus/tsconfig.json",
+  "extends": "@docusaurus/tsconfig",
   "compilerOptions": {
     "jsx": "react",
     "baseUrl": "."

vars.js → vars.ts

@@ -1,6 +1,6 @@
 const latestVersion = "3.1.0";
 
-module.exports = {
+export default {
   title: "LibreTime",
   description: "Radio Broadcast & Automation Platform",
   version: latestVersion,

versioned_docs/version-stable/releases/3.0.0-beta.0.md

@@ -99,7 +99,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **legacy:** track_type_id should cast to int not text ([#2112](https://github.com/libretime/libretime/issues/2112))
 - **worker:** rewrite podcast download task
 - **shared:** load env from oneOf union schema
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.11.1
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.11.1
 - nginx depends on legacy in docker-compose ([#2147](https://github.com/libretime/libretime/issues/2147))
 - **playout:** remove shutdown_handler
 

versioned_docs/version-stable/releases/3.1.0.md

@@ -63,20 +63,20 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **playout:** remove outdated liquidsoap code
 - **playout:** add types
 - **api:** allow single digit version for legacy schema
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.12.1
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.12.1
 - remove systemd ProtectHome feature ([#2243](https://github.com/libretime/libretime/issues/2243))
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.1 ([#2249](https://github.com/libretime/libretime/issues/2249))
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.13.1 ([#2249](https://github.com/libretime/libretime/issues/2249))
 - **worker:** replace deprecated cgi.parse_header
 - **installer:** install missing sudo
 - **installer:** set home and login when running as postgres
 - **legacy:** add log entry on task run ([#2316](https://github.com/libretime/libretime/issues/2316))
 - **legacy:** log errors on connect check failure ([#2317](https://github.com/libretime/libretime/issues/2317))
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.2
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.3
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.13.2
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.13.3
 - **legacy:** advanced search by track type id
 - **legacy:** move forked deps to the libretime namespace
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.14.4
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.14.5
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.14.4
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.14.5
 - **legacy:** ensure options is a dict during json encoding
 - **legacy:** don't use dict assignment on object ([#2384](https://github.com/libretime/libretime/issues/2384))
 - **playout:** quote escape strings in liquidsoap entrypoint
@@ -94,7 +94,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **playout:** prevent unbound variables
 - **playout:** use int for liquidsoap queues map
 - **shared:** return type confusion
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.15.2
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.15.2
 - **api:** explicit FileImportStatusEnum in schema
 - pin postgresql version in docker-compose
 - pin rabbitmq version in docker-compose
@@ -105,7 +105,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **installer:** bump setuptools to ~=67.3 ([#2387](https://github.com/libretime/libretime/issues/2387))
 - **playout:** use new api-client v1
 - **playout:** catch oserror in liquidsoap client
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.16.1 (main) ([#2490](https://github.com/libretime/libretime/issues/2490))
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.16.1 (main) ([#2490](https://github.com/libretime/libretime/issues/2490))
 - **api:** require django >=4.2.0,<4.3
 - **api:** upgrade psycopg to v3.1
 - **playout:** remove unused ecasound package ([#2496](https://github.com/libretime/libretime/issues/2496))
@@ -115,7 +115,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **legacy:** keep datatable settings between views ([#2519](https://github.com/libretime/libretime/issues/2519))
 - **api:** upgrade django code (pre-commit)
 - **analyzer:** remove unused python3 package
-- **deps:** update dependency friendsofphp/php-cs-fixer to <3.17.1 (main) ([#2556](https://github.com/libretime/libretime/issues/2556))
+- **deps:** update dependency friendsofphp/php-cs-fixer to < 3.17.1 (main) ([#2556](https://github.com/libretime/libretime/issues/2556))
 
 ## :arrow_up: Upgrading