Documentation
¶
Overview ¶
Package modules holds the named sets of collections an org installs into its Base: the CRM is one. A module is an import document with a name, and installing it is a grow (core.GrowCollections) — additive, so installing a module again, or a newer version of it, adds what is missing and changes nothing the org already has.
A binary offers the modules it links: each one registers itself in its package's init, and a binary blank-imports the ones it serves.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrUnknownModule = errors.New("unknown module")
ErrUnknownModule is returned for a module nothing registered.
Functions ¶
Types ¶
type Module ¶
type Module struct {
// Name is how the module is addressed (POST /v1/modules/{name}).
Name string `json:"name"`
// Title and Description are what a person reads about it.
Title string `json:"title"`
Description string `json:"description"`
// Collections are the module's collection documents, in the shape an
// import takes. A relation names its collection by name.
Collections []map[string]any `json:"collections"`
}
Module is a named set of collections.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package crm is the CRM as a Base module: the collections an org's sales, hiring and outreach run on, installed into the org's own Base.
|
Package crm is the CRM as a Base module: the collections an org's sales, hiring and outreach run on, installed into the org's own Base. |
Click to show internal directories.
Click to hide internal directories.