Skip to content

GenericGlobalsMutationServerArgs

Defined in: packages/core/src/globals/api/types.ts:51

Base server-side args shared by every globals mutation function (upsertGlobal). Mirrors GenericGlobalsQueryServerArgs but carries a mutation context for writes.

The RBAC seam is identical: when config.access is set, the function runs hasPermission for the global’s slug (write actions use throwOnDenied).

TDataModel extends GenericDataModel

The project’s generated Convex data model.

TGlobalSlug extends GlobalSlug = GlobalSlug

optional access?: AccessCallOptions<MutationCallAction>

Defined in: packages/core/src/globals/api/types.ts:71

Per-call access overrides.

AccessCallOptions


optional auth?: VexApiAuth

Defined in: packages/core/src/globals/api/types.ts:61

Resolved caller identity for permission checks — { user, organization? }, or omitted when access control is off. user may be null for an unauthenticated caller (→ no roles → deny). Never a client argument; the factory resolves it from ctx.auth per request.


config: VexConfig

Defined in: packages/core/src/globals/api/types.ts:69

The resolved VexConfig. Required — supplies config.access (the permission matrix the guard enforces) and config.globals (used to resolve the target GlobalConfig for input validation).


ctx: GenericMutationCtx<TDataModel>

Defined in: packages/core/src/globals/api/types.ts:63

Convex mutation context (read + write DB access).