Commit Graph

164 Commits

Author SHA1 Message Date
Pascal Bleser
5bae16be63 groupware: API documentation updates 2026-04-30 10:51:45 +02:00
Pascal Bleser
0cbf4b7287 groupware: refactor responses to a jmap.Response object
* in the JMAP API as well as in several places in the Groupware
   framework, use a single jmap.Response[T] object to return the
   payload, the language, the session state and the etag/state instead
   of individual multi-valued return values
2026-04-30 10:51:45 +02:00
Pascal Bleser
91e2705bb1 groupware: omit "position" when "anchor" is specified in queries
* the "position" attribute is always set to 0 when using an anchor for
   pagination, but it does not accurately reflect the position and thus
   we decided to remove the attribute from the resulting object for
   clarity

 * omit "canCalculateChanges" attribute when its value is "true", which
   is going to be the case in 100% of calls against Stalwart
2026-04-30 10:51:45 +02:00
Pascal Bleser
b63b0b3f28 groupware: add support for anchor and anchor offset pagination
* add query parameters 'anchor' and 'offset':
   - anchor is an object identifier
   - offset is a numeric offset relative to the anchor
2026-04-30 10:51:45 +02:00
Pascal Bleser
d88a68d1cb groupware: fix use of ?limit=0
* JMAP query limit of 0 is synonymous with "no limit", but we actually
   want to be able to perform queries without any results, for cases
   where we only want to count the total number of objects, and also
   because it makes more sense semantically

 * introduce query parameter validation checks, in order to only allow
   query parameters that are actually supported, which is going to be
   useful during development of clients
2026-04-30 10:51:45 +02:00
Pascal Bleser
652b87d350 groupware: add documentation for SearchResultsTemplate + update pnpm 2026-04-30 10:51:45 +02:00
Pascal Bleser
e4c5e6486d groupware: rename 'offset' to 'position' to be consistent with the JMAP specification 2026-04-30 10:51:45 +02:00
Pascal Bleser
eb4cd432e4 groupware: fix getall template result type: []T instead of RESP 2026-04-30 10:51:45 +02:00
Pascal Bleser
8c41e41c9e groupware: documentation changes after API generator updates for the use of template functions 2026-04-30 10:51:45 +02:00
Pascal Bleser
2883f04488 groupware: refactoring using function templates
* adds creating addressbooks, calendars, mailboxes

 * adds deleting mailbox, event, identity

 * adds modifying an email

 * introduce template functions for the Groupware API in templates.go,
   and use those in route function implementations whenever possible

 * add capability checking for mail, quota, blobs

 * adds Changes interface

 * adds JmapResponse interface
2026-04-30 10:51:45 +02:00
Pascal Bleser
0eb1d47b43 groupware: add endpoints to patch addressbooks, contacts, calendars, events 2026-04-30 10:51:45 +02:00
Pascal Bleser
82b308a5cb groupware: refactoring: pass object type instead of namespaces
* make the JMAP internal API a bit more future-proof by passing
   ObjectType objects instead of the JMAP namespaces

 * remove the new attempt to contain operations even further using the
   Factory objects

 * move CalendarEvent operations to its own file, like everything else

 * fix email tests

 * ignore WS error when closing an already closed connection
2026-04-30 10:51:45 +02:00
Pascal Bleser
ba367aa419 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-04-30 10:51:45 +02:00
Pascal Bleser
7de3ec05a4 groupware: model refactoring, introducing typed interfaces and Foo
* move ContactCard from jscontact to jmap, as it is actually a JMAP
   specification item, but also was causing too many issues with
   circular references from jscontact -> jmap

 * introduce Foo, Idable, GetRequest, GetResponse, etc... types and
   generics

 * first attempt at a Foo factory type for Mailboxes, needs to be
   expanded to further minimize repetition

 * add more specialized template functions to avoid repetition

 * introduce ChangesTemplate[T] for *Changes structs
2026-04-30 10:51:45 +02:00
Pascal Bleser
7d8e3ef1e8 groupware: add addressbook and calendar creation APIs
* add Groupware APIs for creating and deleting addressbooks

 * add Groupware APIs for creating and deleting calendars

 * add JMAP APIs for creating and deleting addressbooks, calendars

 * add JMAP APIs to retrieve Principals

 * fix API tagging

 * move addressbook JMAP APIs into its own file

 * move addressbook Groupware APIs into its own file
2026-04-30 10:51:45 +02:00
Pascal Bleser
f5a9c2235a groupware: add GetIdentityChanges 2026-04-30 10:51:45 +02:00
Pascal Bleser
995ab9f6cd groupware: bump @redocly/cli 2.24.0 -> 2.25.2 2026-04-30 10:51:45 +02:00
Pascal Bleser
98e1701c0a groupware: add changes support for quotas, identities, submissions 2026-04-30 10:51:45 +02:00
Pascal Bleser
0b984a8e2f groupware: framework refactorings + add support for /changes + add /objects 2026-04-30 10:51:45 +02:00
Pascal Bleser
4d9e402cfd groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-04-30 10:51:45 +02:00
Pascal Bleser
8a9a7aebc6 groupware: docs: add a quick copy-pastable block for running ldapsearch 2026-04-30 10:51:45 +02:00
Pascal Bleser
ca7b42a158 groupware: upgrade redocly to 2.24.0 2026-04-30 10:51:45 +02:00
Pascal Bleser
c1f7bc2261 groupware: refactor contactcard changes, and Request framework
* implement ContactCard retrieval endpoint for syncing

 * re-implement that endpoint for Email too

 * fix the Mailbox changes endpoint to actually return changes about
   Mailboxes, and not about Emails

 * when querying the diff of Mailboxes without any prior state, return
   an error since the result is not what one would expect

 * introduce the 'changes' API tag and group

 * refactor the successful response functions to consistently return an
   object type and object state whenever possible

 * move the syncing endpoints under /accounts/*/changes/ for better
   clarity, e.g. /changes/emails instead of /emails/mailbox/*/changes
2026-04-30 10:51:45 +02:00
Pascal Bleser
aee6fb3a67 groupware: upgrade redocly/cli 2.20.0 -> 2.24.0 2026-04-30 10:51:45 +02:00
Pascal Bleser
b12345068c groupware: clarify the ContactCard situation 2026-04-30 10:51:45 +02:00
Pascal Bleser
9f0cf5ef4d groupware: add contact sorting query parameter and fix default sorting (must use updated instead of name) 2026-04-30 10:51:45 +02:00
Pascal Bleser
a3de949e5e groupware: sort contacts in addressbook by name 2026-04-30 10:51:44 +02:00
Pascal Bleser
549fc4642a groupware: fix typos and minor issues
- fix a bunch of minor issues and typos that were found using GoLand
   and gosec

 - add a gosec Makefile target for Groupware related files, in
   services/groupware/Makefile

 - enable checking JMAP session capabilities for events and contacts,
   and only enable skipping that check for tasks until those are
   implemented in Stalwart as well

 - fix a CWE-190 (integer overflow or wraparound) found by gosec

 - consistently use struct references for methods of Groupware and
   Request, instead of mixing up references and copies

 - always log errors when unable to register a Prometheus metric
2026-04-30 10:51:44 +02:00
Pascal Bleser
3eb400a204 groupware: upgrade redocly/cli 2.15.1 -> 2.20.2 2026-04-30 10:51:44 +02:00
Pascal Bleser
199360ae41 groupware: minor logging improvements to the session cache 2026-04-30 10:51:44 +02:00
Pascal Bleser
c400949718 groupware: add OIDC authentication support between Groupware backend and Stalwart
* re-implement the auth-api service to authenticate Reva tokens
   following the OIDC Userinfo endpoint specification

 * pass the context where necessary and add an authenticator interface
   to the JMAP HTTP driver, in order to select between master
   authentication (which is used when GROUPWARE_JMAP_MASTER_USERNAME and
   GROUPWARE_JMAP_MASTER_PASSWORD are both set) and OIDC token
   forwarding through bearer auth

 * add Stalwart directory configuration "idmoidc" which uses the
   OpenCloud auth-api service API (/auth/) to validate the token it
   received as bearer auth from the Groupware backend's JMAP client,
   using it as an OIDC Userinfo endpoint

 * implement optional additional shared secret to secure the Userinfo
   service, as an additional path parameter
2026-04-30 10:51:44 +02:00
Pascal Bleser
8ad3652ba2 groupware: remove remnants of go-swagger documentation, since we are switching to using our own tool instead 2026-04-30 10:51:44 +02:00
Pascal Bleser
8ba07def4c groupware: add jscontact examples, and move them to jmap/model_examples.go to avoid dependency recursion 2026-04-30 10:51:44 +02:00
Pascal Bleser
75f48fca59 groupware: use the OIDC client ID 'web' instead of 'groupware' 2026-04-30 10:51:44 +02:00
Pascal Bleser
700930c3a9 groupware: as suggested in the review PR 1994, remove all filename prefixes that match the package (groupware_xyz.go -> xyz.go), for groupware, jmap, jscontact, jscalendar 2026-04-30 10:51:44 +02:00
Pascal Bleser
7df57c9ef1 groupware: update DEVELOPERS.md based on Jörn's feedback 2026-04-30 10:51:44 +02:00
Pascal Bleser
f91b944aca groupware: bump redocly/cli from 2.14.6 to 2.15.1 2026-04-30 10:51:44 +02:00
Pascal Bleser
4de09d2444 groupware: also update DEVELOPER.md with new OpenAPI documentation generation tooling 2026-04-30 10:51:44 +02:00
Pascal Bleser
f21aa4279f groupware: update README to new API documentation generation process, and remove defunct files 2026-04-30 10:51:44 +02:00
Pascal Bleser
8a3a6160f9 groupware: more API examples 2026-04-30 10:51:44 +02:00
Pascal Bleser
9f686657a3 groupware: change Makefile to use groupware-apidocs instead of go-swagger 2026-04-30 10:51:44 +02:00
Pascal Bleser
8444f9e088 update redocly 2.14.5 -> 2.14.6 2026-04-30 10:51:44 +02:00
Pascal Bleser
8dd74c201a groupware: migrate to cobra instead of urfave 2026-04-30 10:51:44 +02:00
Pascal Bleser
25804d22bf groupware: update pnpm 10.28.0 -> 10.28.1 2026-04-30 10:51:44 +02:00
Pascal Bleser
504e107e11 API documentation changes for groupware-apidocs
* add example generator infrastructure, with some examples for pkg/jmap
   and pkg/groupware, with more needing to be done

 * alter the apidoc Makefile to stop using go-swagger but, instead, use
   the openapi.yml file that must be dropped into that directory using
   groupware-apidocs (will improve the integration there later)

 * add Makefile target to generate examples

 * bump redocly from 2.4.0 to 2.14.5

 * introduce Request.PathParam() and .PathParamDoc() to improve API
   documentation, as well as future-proofing

 * improve X-Request-ID and Trace-Id header handling in the middleware
   by logging it safely when an error occurs in the middleware
2026-04-30 10:51:44 +02:00
Pascal Bleser
1abeba85f0 groupware: shift some attributes of the Groupware object around, in defaults and config sub-structures 2026-04-30 10:51:44 +02:00
Pascal Bleser
73b286e014 groupware: add description and version annotations for env configuration properties 2026-04-30 10:51:44 +02:00
Pascal Bleser
289c9678a9 groupware: add retrieving and adding mailboxIds for drafts and sent if they are missing 2026-04-30 10:51:44 +02:00
Pascal Bleser
90ac2909ef groupware: refactor response objects to take a list of accountIds 2026-04-30 10:51:44 +02:00
Pascal Bleser
f1789dbfe8 groupware: fix missing casting to jmap.State after changes in pkg/jmap 2026-04-30 10:51:43 +02:00