saltcorn-samba 0.3.0 → 0.3.3

package/CHANGELOG.md

@@ -4,6 +4,39 @@ All notable changes to `saltcorn-samba` are documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [0.3.3] – 2026-07-05
+
+### Fixed
+- **`plugin[key] is not a function` beim Installieren behoben.**
+  Saltcorns Plugin-Loader ruft — sobald ein Plugin `configuration_workflow`
+  exportiert — *jeden* weiteren Manifest-Key als Funktion mit der aktuellen
+  Konfiguration als Argument auf (siehe
+  [saltcorn-data/db/state.ts, Fn `withCfg`](https://github.com/saltcorn/saltcorn/blob/master/packages/saltcorn-data/db/state.ts)).
+  In v0.3.2 waren `viewtemplates`, `routes`, `headers` und `dependencies`
+  jedoch statische Arrays — der Aufruf `plugin.viewtemplates(cfg)` warf
+  daher den Fehler. Alle Keys sind jetzt Factory-Funktionen, die den Wert
+  zurückgeben. `plugin_name` als Top-Level-Key wurde entfernt (aus
+  demselben Grund unaufrufbar).
+
+## [0.3.2] – 2026-07-05
+
+### Fixed
+- **Installations-Fehler `plugin[key] is not a function` behoben.**
+  Der Top-Level-Manifest-Key `fieldviews` wurde aus `module.exports`
+  entfernt: Saltcorns Plugin-Loader erlaubt Fieldviews nur eingebettet in
+  ein `types`-Objekt, nicht global. Das Feature `samba_pdf` bleibt im
+  Paket enthalten, wird aber erst mit der geplanten DB-Verknüpfung als
+  echter typgebundener Fieldview reaktiviert. Der inline-PDF-Viewer im
+  `SambaFileManager` und die Route `GET /sambafile?disposition=inline`
+  funktionieren wie bisher.
+
+## [0.3.1] – 2026-07-05
+
+### Fixed
+- `smb-client.js` lädt `@marsaud/smb2` jetzt lazy – `npm test` läuft ohne
+  vorheriges `npm install`, weil die reinen Sanitizer-Helfer keinen SMB-
+  Import mehr auslösen.
+
 ## [0.3.0] – 2026-07-05
 
 ### Added

package/README.md

@@ -9,7 +9,7 @@ Features:
 - ⬆️ **Upload / Neuer Ordner / Umbenennen / Löschen** — optional aktivierbar,
   Multi-File-Upload mit Drag-&-Drop, Toast-Feedback, Rollen-Gate.
 - 🌳 **`SambaTree`-View** — Lazy-loading Verzeichnisbaum, ideal zum Einbetten in Show-Views.
-- 📄 **`samba_pdf`-Fieldview** — String-Feld mit Datei-Pfad → PDF/Bild inline im Browser, plus Download- und externe-App-Buttons.
+- 📄 **Inline-PDF-/Bild-Anzeige** direkt im `SambaFileManager` (Klick auf eine Datei), plus Download- und externe-App-Buttons.
 - 🚀 **`smb://`-Links** — Öffnet Dateien und Ordner direkt in Nemo, Nautilus, Dolphin (Linux) oder Explorer (Windows).
 - 🔒 **Sicherheit** — Base-Path als „Chroot", strenge Path-Traversal-Prüfung (`..`, absolute Pfade, UNC, Drive-Letters, NUL-Bytes), CSRF-Schutz auf Schreib-Routen, Filename-Sanitizer, Extension-Blocklist, rollenbasierter Zugriff (getrennte Lese-/Schreib-Rollen).
 - 🐳 **Docker-freundlich** — direkt per SMB2-Protokoll, keine System-Binaries nötig.
@@ -168,7 +168,15 @@ Mode = `from_field`, Row field = `akte_dir` einbetten.
 Kompaktere Alternative – lazy-loading Baum, ideal in einer Sidebar oder
 neben Formularen. Gleiche Path-Modi wie beim File-Manager.
 
-### Fieldview `samba_pdf`
+### Fieldview `samba_pdf` (deaktiviert seit 0.3.2)
+
+> Der eigenständige Fieldview `samba_pdf` ist temporär nicht als
+> Fieldview registriert, weil er ohne DB-Verknüpfung an einen konkreten
+> Saltcorn-Typ gebunden werden müsste. Er kehrt in einer späteren
+> Version zusammen mit der DB-Integration zurück. Bis dahin liefert der
+> `SambaFileManager` selbst die Inline-Anzeige.
+
+_Historische Beschreibung:_
 
 Für ein String-Feld mit Datei-Pfad (relativ zum Base-Path). In der View-
 Konfiguration `Field view = samba_pdf` wählen. Rendert PDFs im `<iframe>`,

package/index.js

@@ -38,7 +38,8 @@ const {
 } = require("./smb-client");
 const treeView = require("./tree-view");
 const fileManagerView = require("./filemanager-view");
-const { samba_pdf } = require("./pdf-view");
+// pdf-view is intentionally NOT wired into the manifest (see note at bottom).
+// The file is kept in the package so the DB-linkage release can revive it.
 
 const PLUGIN_VERSION = pkg.version;
 const PLUGIN_NAME = "saltcorn-samba@" + PLUGIN_VERSION;
@@ -606,17 +607,34 @@ function wrapView(v) {
 // Manifest
 // ---------------------------------------------------------------------------
 
+// ---------------------------------------------------------------------------
+// IMPORTANT: how Saltcorn iterates the manifest
+// ---------------------------------------------------------------------------
+// When a plugin exports `configuration_workflow`, Saltcorn's state loader
+// treats EVERY other manifest key as a factory function and calls it with the
+// current plugin configuration — see
+// packages/saltcorn-data/db/state.ts `withCfg` (`plugin[key](cfg || {})`).
+// So each key below must be a function that returns the value, otherwise
+// Node throws `plugin[key] is not a function`. The only exceptions are the
+// bookkeeping keys `sc_plugin_api_version` and `configuration_workflow`
+// itself, which the loader accesses directly.
+// ---------------------------------------------------------------------------
+
 module.exports = {
   sc_plugin_api_version: 1,
-  plugin_name: PLUGIN_NAME,
   configuration_workflow,
-  viewtemplates: [wrapView(fileManagerView), wrapView(treeView)],
-  fieldviews: {
-    samba_pdf,
-  },
-  routes,
-  headers: [
+  viewtemplates: () => [wrapView(fileManagerView), wrapView(treeView)],
+  routes: () => routes,
+  headers: () => [
     { css: `/plugins/public/${PLUGIN_NAME}/samba.css` },
   ],
-  dependencies: [],
+  dependencies: () => [],
 };
+
+// Note: the `samba_pdf` fieldview shipped in v0.1–0.3.1 has been removed from
+// the top-level manifest because Saltcorn's plugin loader requires field
+// views to be attached to a type, not registered globally. The inline PDF /
+// image viewer is still available through the SambaFileManager view (click a
+// row) and via the `GET /sambafile?path=...&disposition=inline` route.
+// A properly-typed reintroduction of `samba_pdf` will follow together with
+// the DB-linkage feature in a later release.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saltcorn-samba",
-  "version": "0.3.0",
+  "version": "0.3.3",
   "description": "Saltcorn plugin: browse, upload, rename and delete files on a Samba/CIFS share. File-manager view, directory tree, inline PDF viewer, external-app open (smb://).",
   "main": "index.js",
   "scripts": {
@@ -49,8 +49,5 @@
   ],
   "publishConfig": {
     "access": "public"
-  },
-  "directories": {
-    "test": "test"
   }
 }

package/smb-client.js

@@ -7,7 +7,16 @@
  */
 
 const path = require("path");
-const SMB2 = require("@marsaud/smb2");
+
+// @marsaud/smb2 is loaded lazily so the pure sanitizer helpers exported by
+// this module can be required (e.g. from unit tests) without needing the
+// native SMB dependency installed.
+let _SMB2 = null;
+function getSMB2() {
+  if (_SMB2) return _SMB2;
+  _SMB2 = require("@marsaud/smb2");
+  return _SMB2;
+}
 
 // ---------------------------------------------------------------------------
 // Path helpers
@@ -108,6 +117,7 @@ function buildClient(config) {
   if (/[\\/]/.test(share)) throw new Error("Samba: share must not contain slashes");
 
   const shareStr = `\\\\${server}${port ? ":" + port : ""}\\${share}`;
+  const SMB2 = getSMB2();
   const smb = new SMB2({
     share: shareStr,
     domain: domain || "WORKGROUP",