README
¶
User module
modules/user is the people in a tenant: one entity, a rest.Spec at
/api/v1/user/users guarded by user:read and user:manage, invitations at
/api/v1/user/invitations, explicit lifecycle commands, and pending
registrations for compositions that want operator approval (user:approve
guards the approve-registration command). A user belongs to a tenant by
carrying its id, which row-level security matches on, so the module takes no
dependencies: user.Deps{}.
Provision is what platformkit bootstrap calls to create the first
administrator with a password; the argon2id parameters are constants here.
Consumers import contracts/ — users, registration, password
rules, events, permissions and the fake — never
internal/. The admin entry is /admin/user/users.
Documentation
¶
Overview ¶
Package user is the module manifest: the people in a tenant.
It is the exemplar's shape with one entity, one Spec and explicit lifecycle commands, and it takes no dependencies at all: a user belongs to a tenant by carrying its id, which row-level security matches on, so there is nothing for this module to ask the tenant module for.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Migrations = db.MigrationSource{ Owner: "user", Files: db.Sub(schema, "migrations"), Adopts: []db.Adoption{{Owner: "platformkit", Versions: []int64{7}}}, }
Migrations is this module's SQL as one source — the users table — owned as "user". The manifest hands the kernel the same files and adoption, and a test composes the schema it needs beside the foundation: dbtest.Schema(t, user.Migrations).
The files keep the version numbers they had when the foundation applied them under its own name, so an installation migrated before this module owned its SQL is adopted by checksum rather than migrated again (see db.Adoption and docs/adr/0011). New files continue from the highest number.
Functions ¶
Types ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package contracts is everything another module, an app or a test may know about users: the entity, the events, the permissions and the Service interface.
|
Package contracts is everything another module, an app or a test may know about users: the entity, the events, the permissions and the Service interface. |
|
usertest
Package usertest is the conformance suite for contracts.Service, and a fake that passes it.
|
Package usertest is the conformance suite for contracts.Service, and a fake that passes it. |
|
Package internal is every implementation of the user module.
|
Package internal is every implementation of the user module. |