go-nc-files/README.md

go-nc-files

Shared Go library for Nextcloud ExApp Services: a User Files seam (local disk and WebDAV), Saved Default path storage, and Visit-scoped Working Folder resolution.

Import: gitea.neitzel.de/konrad/go-nc-files (package goncfiles).

go get gitea.neitzel.de/konrad/go-nc-files

Depends on go-nc-exapp for AppAPI credentials on WebDAV.

• Guide — how to call each capability
• API — every exported symbol
• Domain language

Included

• Files seam — Root and Folder
• Local — filesystem-backed User Files Root
• WebDAVRoot — Nextcloud Files over WebDAV
• CleanRel — User Files Root–relative paths
• RequireBasename — child file names
• DefaultPathStore — Saved Default path
• Visit — Working Folder for one opening

Excluded

• ExApp lifecycle HTTP routes and HaRP bootstrap (see go-nc-exapp)
• AppAPI preference OCS wiring (the ExApp adapts gonexapp.AppAPIPreferences to DefaultPathStore)
• Catalog, DNS, or product-specific file semantics
• Recursive tree walks and Nextcloud numeric file IDs

Testing

Unit tests use a temporary local root and httptest for WebDAV. No live Nextcloud is required.

go test ./... fails when docs/api.md does not match the exported API. Regenerate it with:

UPDATE_API_DOCS=1 go test -run TestAPIDoc -count=1

Runnable package examples: go test -run Example.

Related

• go-nc-exapp — AppAPI credentials and OCS preferences
• Workspace ADR 0013 — extraction from CheckDNS