Directories
¶
| Path | Synopsis |
|---|---|
|
Package archive is the Hubtask archive format of backup-restore.md §3: what a backup writes and what a restore reads, as a reader and a writer over the backup target port.
|
Package archive is the Hubtask archive format of backup-restore.md §3: what a backup writes and what a restore reads, as a reader and a writer over the backup target port. |
|
Package catalogue is the list of every use case this build has, once.
|
Package catalogue is the list of every use case this build has, once. |
|
Package condition is the vocabulary an expression may use, and the shape of what it is told.
|
Package condition is the vocabulary an expression may use, and the shape of what it is told. |
|
repository
|
|
|
activity
Package activity declares how an item's history is written and how it is read back.
|
Package activity declares how an item's history is written and how it is read back. |
|
admin
Package admin holds the control plane's outbound ports (multi-tenancy.md §5).
|
Package admin holds the control plane's outbound ports (multi-tenancy.md §5). |
|
audit
Package audit declares how the evidence trail is read back.
|
Package audit declares how the evidence trail is read back. |
|
automation
Package automation is the repository port of the rules (automation.md §1).
|
Package automation is the repository port of the rules (automation.md §1). |
|
backup
Package backup is the outbound port for the targets a tenant has configured.
|
Package backup is the outbound port for the targets a tenant has configured. |
|
idempotency
Package idempotency declares what the idempotency guard needs from storage.
|
Package idempotency declares what the idempotency guard needs from storage. |
|
identity
Package identity declares what the identity use cases need from storage.
|
Package identity declares what the identity use cases need from storage. |
|
importer
Package importer is the outbound side of an import: the run's repository, and the converter port - a foreign file in, archive records out.
|
Package importer is the outbound side of an import: the run's repository, and the converter port - a foreign file in, archive records out. |
|
integration
Package integration holds the repository ports of what reaches into this system from outside it: today the calendar feeds, later the webhook subscriptions beside them.
|
Package integration holds the repository ports of what reaches into this system from outside it: today the calendar feeds, later the webhook subscriptions beside them. |
|
job
Package job is the outbound port for background work as a caller sees it.
|
Package job is the outbound port for background work as a caller sees it. |
|
jumble
Package jumble is the repository port of the inbox (domain-model.md §2).
|
Package jumble is the repository port of the inbox (domain-model.md §2). |
|
lifecycle
Package lifecycle declares what the end of data's life needs stored: the instructions not to delete, and the record of what was deleted anyway.
|
Package lifecycle declares what the end of data's life needs stored: the instructions not to delete, and the record of what was deleted anyway. |
|
mail
Package mail is the store of a workspace's mail intake (ADR-0094): its settings, the receipts of what it received, and the lookups that route a message.
|
Package mail is the store of a workspace's mail intake (ADR-0094): its settings, the receipts of what it received, and the lookups that route a message. |
|
media
Package media declares what the media use cases need from storage of the *records* - the rows beside the bytes.
|
Package media declares what the media use cases need from storage of the *records* - the rows beside the bytes. |
|
meta
Package meta declares what the self-description needs from storage.
|
Package meta declares what the self-description needs from storage. |
|
notification
Package notification declares what the notification path needs from storage: the records it writes, and the preferences it honours.
|
Package notification declares what the notification path needs from storage: the records it writes, and the preferences it honours. |
|
outbox
Package outbox declares how a domain event leaves the write path.
|
Package outbox declares how a domain event leaves the write path. |
|
privacy
Package privacy declares what data subject rights need stored: the case, the consent, and the two marks an erasure leaves on things it does not delete.
|
Package privacy declares what data subject rights need stored: the case, the consent, and the two marks an erasure leaves on things it does not delete. |
|
quota
Package quota holds the outbound ports of the §4 limits (multi-tenancy.md).
|
Package quota holds the outbound ports of the §4 limits (multi-tenancy.md). |
|
sealing
Package sealing is the census a rotation ends on (ADR-0045, security.md §8.1): how many stored values still name each master key, and in which kind of value.
|
Package sealing is the census a rotation ends on (ADR-0045, security.md §8.1): how many stored values still name each master key, and in which kind of value. |
|
streams
Package streams holds the outbound port of the partitioned streams' maintenance: activity entries, outbox events and rule runs partition by month, the leader keeps the coming months existing, and the retention engine drops what has wholly aged out.
|
Package streams holds the outbound port of the partitioned streams' maintenance: activity entries, outbox events and rule runs partition by month, the leader keeps the coming months existing, and the retention engine drops what has wholly aged out. |
|
suggestion
Package suggestion is the outbound port of what AI proposed.
|
Package suggestion is the outbound port of what AI proposed. |
|
sync
Package sync declares what offline clients need recorded about a change.
|
Package sync declares what offline clients need recorded about a change. |
|
view
Package view declares how the application layer stores saved views.
|
Package view declares how the application layer stores saved views. |
|
voice
Package voice is the store of a workspace's voice settings (ADR-0093).
|
Package voice is the store of a workspace's voice settings (ADR-0093). |
|
work
Package work declares what the work management use cases need from storage.
|
Package work declares what the work management use cases need from storage. |
|
service
|
|
|
access
Package access decides whether an actor may do something.
|
Package access decides whether an actor may do something. |
|
admin
Package admin holds the control plane's use cases: the lifecycle of a tenant, as multi-tenancy.md §5 draws it.
|
Package admin holds the control plane's use cases: the lifecycle of a tenant, as multi-tenancy.md §5 draws it. |
|
audit
Package audit is the trail as somebody reads it: a page of it, an archive of it, and the check that it has not been rewritten (audit.md §5).
|
Package audit is the trail as somebody reads it: a page of it, an archive of it, and the check that it has not been rewritten (audit.md §5). |
|
automation
Package automation holds the use cases that write the rules (automation.md §1).
|
Package automation holds the use cases that write the rules (automation.md §1). |
|
backup
Package backup is where an operator says where backups go, and finds out whether they can (backup-restore.md §2).
|
Package backup is where an operator says where backups go, and finds out whether they can (backup-restore.md §2). |
|
idempotency
Package idempotency makes a repeated write harmless.
|
Package idempotency makes a repeated write harmless. |
|
identity
Package identity holds the use cases that turn a credential into an actor.
|
Package identity holds the use cases that turn a credential into an actor. |
|
importer
Package importer is an import from another system (backup-restore.md §9): the use case that accepts one, the read that answers its report, and the job that runs it.
|
Package importer is an import from another system (backup-restore.md §9): the use case that accepts one, the read that answers its report, and the job that runs it. |
|
integration
Package integration holds the use cases that let another system reach into this one, and this one reach out: today the webhook subscriptions, later the trigger polling and the jumble's inbound routes.
|
Package integration holds the use cases that let another system reach into this one, and this one reach out: today the webhook subscriptions, later the trigger polling and the jumble's inbound routes. |
|
job
Package job is the caller's half of the queue: finding out how a piece of background work is getting on, and stopping it.
|
Package job is the caller's half of the queue: finding out how a piece of background work is getting on, and stopping it. |
|
jumble
Package jumble holds the use cases of the inbox (domain-model.md §5): something arrives, is listed, and becomes work or ages out.
|
Package jumble holds the use cases of the inbox (domain-model.md §5): something arrives, is listed, and becomes work or ages out. |
|
lifecycle
Package lifecycle is where data stops existing: the hard delete, and the rules that decide when it is allowed (ADR-0020, data-retention.md).
|
Package lifecycle is where data stops existing: the hard delete, and the rules that decide when it is allowed (ADR-0020, data-retention.md). |
|
mail
Package mail is the administration of a workspace's mail intake (ADR-0094): its settings, its log, a collection's handle, and the address a notification's reply goes to.
|
Package mail is the administration of a workspace's mail intake (ADR-0094): its settings, its log, a collection's handle, and the address a notification's reply goes to. |
|
media
Package media is the upload life of a file: staged, carried to storage by somebody other than this server, confirmed, and eventually reclaimed (arc42 §8.4).
|
Package media is the upload life of a file: staged, carried to storage by somebody other than this server, confirmed, and eventually reclaimed (arc42 §8.4). |
|
meta
Package meta answers what this installation is and what it can do.
|
Package meta answers what this installation is and what it can do. |
|
notification
Package notification is the application half of the Notification context: the consumer that turns events into records, and the delivery that turns a record into a message.
|
Package notification is the application half of the Notification context: the consumer that turns events into records, and the delivery that turns a record into a message. |
|
platform
Package platform writes the installation's events: what a provider's purchase platform learns about a workspace (UC-INS-14, multi-tenancy.md §4.3).
|
Package platform writes the installation's events: what a provider's purchase platform learns about a workspace (UC-INS-14, multi-tenancy.md §4.3). |
|
privacy
Package privacy is data subject rights as use cases rather than as a support process (data-protection.md §4, ADR-0018 decision 4).
|
Package privacy is data subject rights as use cases rather than as a support process (data-protection.md §4, ADR-0018 decision 4). |
|
quota
Package quota turns multi-tenancy.md §4's table into enforcement: per-tenant limits from `tenant.settings.quotas` with the mode's defaults, one resolution, one refusal shape.
|
Package quota turns multi-tenancy.md §4's table into enforcement: per-tenant limits from `tenant.settings.quotas` with the mode's defaults, one resolution, one refusal shape. |
|
sealing
Package sealing is the half of a key rotation that lets it finish (ADR-0045, security.md §8.1).
|
Package sealing is the half of a key rotation that lets it finish (ADR-0045, security.md §8.1). |
|
suggestion
Package suggestion is the application layer of what AI proposed.
|
Package suggestion is the application layer of what AI proposed. |
|
sync
Package sync is the application half of the change stream: what a client is allowed to be told about, and where in the log it stands (ADR-0021).
|
Package sync is the application half of the change stream: what a client is allowed to be told about, and where in the log it stands (ADR-0021). |
|
voice
Package voice turns what a person says to a voice assistant into work (ADR-0093): entries put on a list, a list read out, an entry ticked off, the day's due entries told.
|
Package voice turns what a person says to a voice assistant into work (ADR-0093): entries put on a list, a list read out, an entry ticked off, the day's due entries told. |
|
work
Package work holds the work management use cases: containers and the items inside them.
|
Package work holds the work management use cases: containers and the items inside them. |
|
Package shared holds what every use case needs regardless of its context: who is acting, in which tenant, with which permissions, and in which language the answer is to be rendered.
|
Package shared holds what every use case needs regardless of its context: who is acting, in which tenant, with which permissions, and in which language the answer is to be rendered. |
|
Package usecase is the catalogue: every use case the system has, once.
|
Package usecase is the catalogue: every use case the system has, once. |
Click to show internal directories.
Click to hide internal directories.