@lars_hagemann/mediaserver-frontend-plugin-types 0.24.3 → 0.25.0

package/package.json

@@ -1,61 +1,25 @@
 {
   "name": "@lars_hagemann/mediaserver-frontend-plugin-types",
-  "version": "0.24.3",
+  "version": "0.25.0",
   "files": [
-    "types",
-    "README.md"
+    "types"
   ],
   "type": "module",
   "types": "types/plugin.d.ts",
   "repository": {
-    "url": "https://github.com/LarsHagemann/mediaserver"
+    "url": "https://github.com/de-treelab/mediaserver"
   },
   "scripts": {
-    "dev": "vite --host 0.0.0.0",
-    "build": "tsc -b && vite build",
-    "preview": "vite preview --host 0.0.0.0",
-    "lint:check": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "style:check": "prettier --check src/**/*.ts",
-    "style:fix": "prettier --write src/**/*.ts",
-    "types:plugins": "tsc -p tsconfig.plugin.json",
-    "prepare": "npm run types:plugins"
-  },
-  "dependencies": {
-    "@lars_hagemann/tags": "^1.0.4",
-    "@reduxjs/toolkit": "^2.9.2",
-    "@tailwindcss/vite": "^4.1.12",
-    "luxon": "^3.7.2",
-    "react": "^19.1.1",
-    "react-dom": "^19.1.1",
-    "react-i18next": "^15.7.3",
-    "react-icons": "^5.5.0",
-    "react-paginate": "^8.3.0",
-    "react-redux": "^9.2.0",
-    "react-router": "^7.8.2",
-    "react-use-websocket": "^4.13.0",
-    "redux-persist": "^6.0.0",
-    "tailwind-merge": "^3.3.1",
-    "tailwindcss": "^4.1.12",
-    "zod": "^4.1.5"
+    "types": "tsc -p tsconfig.plugin.json",
+    "prepare": "npm run types"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.53.3",
-    "@types/luxon": "^3.7.1",
-    "@types/react": "^19.1.10",
-    "@types/react-dom": "^19.1.7",
-    "@types/react-paginate": "^7.1.4",
-    "@vitejs/plugin-react": "^5.0.0",
-    "eslint": "^9.33.0",
-    "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^5.2.0",
-    "eslint-plugin-react-refresh": "^0.4.20",
-    "globals": "^16.3.0",
-    "prettier": "^3.6.2",
-    "sass-embedded": "^1.91.0",
-    "typescript": "~5.8.3",
-    "typescript-eslint": "^8.39.1",
-    "unplugin-dts": "^1.0.0-beta.0",
-    "vite": "^7.1.2"
+    "@types/react": "^19.2.2",
+    "@types/react-icons": "^2.2.7",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "react": "^19.2.0",
+    "react-icons": "^5.5.0"
   }
 }

package/types/plugin.d.ts

@@ -1,4 +1,5 @@
 import type { IconType } from "react-icons";
+import React from "react";
 export declare const reactIcons: {
     default: typeof import("react-icons/gi");
     Gi3dGlasses: IconType;
@@ -9997,7 +9998,7 @@ export declare const reactIcons: {
 export type ReactIcons = typeof reactIcons;
 export type RenderContext = {
     objectUrl: string;
-    React: typeof import("react");
+    React: typeof React;
 };
 export type DiashowContext = RenderContext & {
     nextDocument: () => void;

package/README.md

@@ -1,186 +0,0 @@
-# Mediaserver Frontend
-
-## Usage
-
-The recommended way to use this software is using Docker:
-
-```yml
-services:
-  server:
-    image: treelabmediaserver/mediaserver-backend:stable
-    depends_on:
-      postgres:
-        condition: service_healthy
-      redis:
-        condition: service_healthy
-    restart: always
-    environment:
-      POSTGRES_HOST: postgres
-      REDIS_HOST: redis
-      DOCUMENT_STORE_CONFIG_PATH: /config.json
-    volumes:
-      - /my-partition:/store-0
-      - /tmp:/tmp
-      - ./documentStoreConfig.json:/config.json
-    ports:
-      - ${BACKEND_PORT}:${BACKEND_PORT}
-      - ${WEBSOCKET_PORT}:${WEBSOCKET_PORT}
-    healthcheck: 
-      test: ["CMD", "curl", "-f", "http://localhost:${BACKEND_PORT}/health"]
-      interval: 30s
-      timeout: 5s
-      retries: 3
-
-  postgres:
-    image: postgres:16
-    healthcheck:
-      test: ["CMD", "pg_isready", "-U", "dev"]
-      interval: 5s
-      timeout: 5s
-      retries: 5
-    restart: always
-    volumes:
-      - postgres_data:/var/lib/postgresql/data
-    
-  redis:
-    image: redis:latest
-    healthcheck:
-      test: ["CMD", "redis-cli", "ping"]
-      interval: 5s
-      timeout: 5s
-      retries: 5
-    restart: always
-    volumes:
-      - redis_data:/data
-
-  frontend:
-    image: treelabmediaserver/mediaserver-web:stable
-    depends_on:
-      server:
-        condition: service_healthy
-    restart: always
-    environment:
-      MEDIASERVER_BACKEND_URL: "http://${BACKEND_URL}:${BACKEND_PORT}"
-      MEDIASERVER_WEBSOCKET_URL: "ws://${BACKEND_URL}:${WEBSOCKET_PORT}"
-    ports:
-      - 80:80
-
-volumes:
-  postgres_data:
-  redis_data:
-```
-
-with a corresponding `.env` file
-
-```sh
-BACKEND_URL=<your-url>
-BACKEND_PORT=8080
-WEBSOCKET_PORT=8081
-
-POSTGRES_PORT=5432
-POSTGRES_DB=mediaserver
-POSTGRES_USER=<your-user>
-POSTGRES_PASSWORD=<your-password>
-
-REDIS_ENDPOINT=redis
-REDIS_PORT=6379
-REDIS_USERNAME=<your-user>
-REDIS_PASSWORD=<your-password>
-```
-
-## Translations
-
-You can install additional installations by creating a custom `manifest.json` and copying your translation into the container. 
-
-```yml
-services:
-  frontend:
-    image: treelabmediaserver/mediaserver-web
-    volumes:
-      - ./manifest.json:/var/www/html/manifest.json
-      - ./fr.json:/var/www/html/translations/fr.json
-```
-
-Your manifest could look like this:
-```json
-{
-  "plugins": [],
-  "translations": [
-    {
-      "lang": "fr",
-      "path": "/translations/fr.json",
-      "name": "French",
-      "localName": "Français",
-      "flag": "🇫🇷"
-    },
-    {
-      "lang": "it",
-      "path": "https://some-cdn.net/mediaserver/it.json",
-      "name": "Italian",
-      "localName": "Italiano",
-      "flag": "🇮🇹"
-    }
-  ]
-}
-```
-
-I am not going to support other languages other than english and german out of the box, since I cannot maintain other languages and I don't want some locales to be in a broken state. 
-
-## Plugins
-
-Installing plugins works similar to installing language extensions. You need to update your manifest.json and copy the plugin JS file into your docker container:
-
-```yml
-services:
-  frontend:
-    image: treelabmediaserver/mediaserver-web
-    volumes:
-      - ./manifest.json:/var/www/html/manifest.json
-      - ./fr.json:/var/www/html/translations/fr.json
-      - ./csvPlugin.js:/var/www/html/plugins/csvPlugin.js
-```
-
-Your manifest could look like this:
-
-```json
-{
-  "plugins": [
-    {
-      "name": "csv-plugin",
-      "url": "/plugins/csvPlugin.js",
-    },
-    {
-      "name": "plain-plugin",
-      "url": "https://some-cdn.net/mediaserver/plainPlugin.js",
-    }
-  ],
-  "translations": [
-    {
-      "lang": "fr",
-      "path": "/translations/fr.json",
-      "name": "French",
-      "localName": "Français",
-      "flag": "🇫🇷"
-    }
-  ]
-}
-```
-
-## Developing plugins
-
-Plugins need to export a default object that implements the `FileTypePlugin` interface. The `csvPlugin.js` plugin could look like this:
-
-```js
-const csvPlugin = {
-  matcher: (type) => type === "text/csv",
-  icon: (icons) => icons.FaFileCsv,
-  Render: (context) => (
-    // ...
-  ),
-  Diashow: (context) => {
-    // ...
-  },
-};
-
-export default csvPlugin;
-```