Directories
¶
| Path | Synopsis |
|---|---|
|
Package access implements the v0.3 access-control core (ADR-0007, spec §5): capability-based permission checks over explicit space grants with subject-side team expansion, resolved once per request and cached on the request context.
|
Package access implements the v0.3 access-control core (ADR-0007, spec §5): capability-based permission checks over explicit space grants with subject-side team expansion, resolved once per request and cached on the request context. |
|
Package analytics provides usage and performance reporting for Azimuthal.
|
Package analytics provides usage and performance reporting for Azimuthal. |
|
Package api wires all HTTP handlers together into a chi router and applies cross-cutting middleware.
|
Package api wires all HTTP handlers together into a chi router and applies cross-cutting middleware. |
|
admin
Package admin provides the org-administration HTTP surface (P2.5): the People directory and user lifecycle, the member picker search, the access matrix with atomic bulk editing, and the audit log viewer.
|
Package admin provides the org-administration HTTP surface (P2.5): the People directory and user lifecycle, the member picker search, the access matrix with atomic bulk editing, and the audit log viewer. |
|
attachments
Package attachments provides HTTP handlers for entity attachments (P3, ADR-0008 rule 3).
|
Package attachments provides HTTP handlers for entity attachments (P3, ADR-0008 rule 3). |
|
auth
Package auth provides HTTP handlers for authentication endpoints.
|
Package auth provides HTTP handlers for authentication endpoints. |
|
avatar
Package avatar serves the user avatar surface: self and admin upload plus the org-member-readable serve endpoint.
|
Package avatar serves the user avatar surface: self and admin upload plus the org-member-readable serve endpoint. |
|
comments
Package comments provides HTTP handlers for polymorphic entity comment endpoints.
|
Package comments provides HTTP handlers for polymorphic entity comment endpoints. |
|
dashboards
Package dashboards provides HTTP handlers for dashboards and gadgets (P5, ADR-0009, spec §6) — composable grids whose data always comes from the saved-view layer.
|
Package dashboards provides HTTP handlers for dashboards and gadgets (P5, ADR-0009, spec §6) — composable grids whose data always comes from the saved-view layer. |
|
grants
Package grants provides HTTP handlers for space grants and the effective-access explanation (v0.3 spec §6).
|
Package grants provides HTTP handlers for space grants and the effective-access explanation (v0.3 spec §6). |
|
invites
Package invites provides the invite HTTP surface (P2.5 W2): the org-admin lifecycle (create, list, revoke, resend) and the public token-authenticated acceptance routes.
|
Package invites provides the invite HTTP surface (P2.5 W2): the org-admin lifecycle (create, list, revoke, resend) and the public token-authenticated acceptance routes. |
|
notifications
Package notifications provides HTTP handlers for in-app notification endpoints.
|
Package notifications provides HTTP handlers for in-app notification endpoints. |
|
portal
Package portal serves the customer portal: the unauthenticated sign-in surface and the requester-authenticated request surface.
|
Package portal serves the customer portal: the unauthenticated sign-in surface and the requester-authenticated request surface. |
|
projects
Package projects provides HTTP handlers for project tracking endpoints.
|
Package projects provides HTTP handlers for project tracking endpoints. |
|
relations
Package relations provides HTTP handlers for the polymorphic entity relation endpoints.
|
Package relations provides HTTP handlers for the polymorphic entity relation endpoints. |
|
respond
Package respond provides shared JSON response helpers for HTTP handlers.
|
Package respond provides shared JSON response helpers for HTTP handlers. |
|
search
Package search serves the cross-module search endpoint (P6, spec §5 and §7).
|
Package search serves the cross-module search endpoint (P6, spec §5 and §7). |
|
shares
Package shares provides HTTP handlers for entity shares (v0.3 spec §6, ADR-0008).
|
Package shares provides HTTP handlers for entity shares (v0.3 spec §6, ADR-0008). |
|
spaces
Package spaces provides HTTP handlers for space management and the org space directory (v0.3 spec §6).
|
Package spaces provides HTTP handlers for space management and the org space directory (v0.3 spec §6). |
|
swaggerui
Package swaggerui embeds the Swagger UI static assets that /api/docs needs.
|
Package swaggerui embeds the Swagger UI static assets that /api/docs needs. |
|
teams
Package teams provides HTTP handlers for team management (v0.3 spec §6).
|
Package teams provides HTTP handlers for team management (v0.3 spec §6). |
|
ticketref
Package ticketref carries the operator-supplied ticket reference that administrative mutations record on their audit events.
|
Package ticketref carries the operator-supplied ticket reference that administrative mutations record on their audit events. |
|
tickets
Package tickets provides HTTP handlers for service desk endpoints.
|
Package tickets provides HTTP handlers for service desk endpoints. |
|
tiergate
Package tiergate adapts the workflow tier chokepoint to the HTTP layer.
|
Package tiergate adapts the workflow tier chokepoint to the HTTP layer. |
|
views
Package views provides HTTP handlers for saved views (ADR-0009, ADR-0010, spec §6) — named, reusable queries over Beacon tickets and Vector project items.
|
Package views provides HTTP handlers for saved views (ADR-0009, ADR-0010, spec §6) — named, reusable queries over Beacon tickets and Vector project items. |
|
wiki
Package wiki provides HTTP handlers for wiki/docs endpoints.
|
Package wiki provides HTTP handlers for wiki/docs endpoints. |
|
workflows
Package workflows provides HTTP handlers for workflow engine endpoints.
|
Package workflows provides HTTP handlers for workflow engine endpoints. |
|
Package attachments implements entity attachments (P3, ADR-0008 rule 3: "attachments follow the entity").
|
Package attachments implements entity attachments (P3, ADR-0008 rule 3: "attachments follow the entity"). |
|
Package audit defines the AuditLogger interface for recording structured, append-only audit events.
|
Package audit defines the AuditLogger interface for recording structured, append-only audit events. |
|
Package auth provides local user authentication, JWT issuance, and HTTP middleware.
|
Package auth provides local user authentication, JWT issuance, and HTTP middleware. |
|
Package customfields manages org-scoped custom field definitions, the per-space/per-entity-type scopes that attach them to forms, and the values entities hold under them.
|
Package customfields manages org-scoped custom field definitions, the per-space/per-entity-type scopes that attach them to forms, and the values entities hold under them. |
|
Package dashboards implements dashboards and the gadget registry (P5, ADR-0009, migration 048): composable grids of gadgets whose data always comes from the saved-view layer, resolved per viewer on every render.
|
Package dashboards implements dashboards and the gadget registry (P5, ADR-0009, migration 048): composable grids of gadgets whose data always comes from the saved-view layer, resolved per viewer on every render. |
|
Package email provides the interface and implementations for sending email.
|
Package email provides the interface and implementations for sending email. |
|
Package invites implements the organisation invite lifecycle (P2.5 W2): create, list, revoke, resend, accept.
|
Package invites implements the organisation invite lifecycle (P2.5 W2): create, list, revoke, resend, accept. |
|
Package itemtypes manages org-scoped Vector item types (task, story, bug, epic, and any org-defined additions).
|
Package itemtypes manages org-scoped Vector item types (task, story, bug, epic, and any org-defined additions). |
|
Package notifications handles email and in-app alert delivery.
|
Package notifications handles email and in-app alert delivery. |
|
Package people implements administrative user lifecycle within an org (P2.5 W2/W4): listing members, deactivation and reactivation, force logout, removal from the org, and org role and primary team changes.
|
Package people implements administrative user lifecycle within an org (P2.5 W2/W4): listing members, deactivation and reactivation, force logout, removal from the org, and org role and primary team changes. |
|
Package portal implements the customer portal: the surface on which an external requester raises and tracks requests against one Beacon service desk without holding an account.
|
Package portal implements the customer portal: the surface on which an external requester raises and tracks requests against one Beacon service desk without holding an account. |
|
Package projects implements project tracking: backlog, sprints, roadmap, and cross-tool item linking.
|
Package projects implements project tracking: backlog, sprints, roadmap, and cross-tool item linking. |
|
Package rbac provides role-based access control for Azimuthal.
|
Package rbac provides role-based access control for Azimuthal. |
|
Package search is the cross-module search read path (P6, spec §5 and §7).
|
Package search is the cross-module search read path (P6, spec §5 and §7). |
|
Package spaces holds the space domain types that outlive any one layer.
|
Package spaces holds the space domain types that outlive any one layer. |
|
Package sso defines the SSOProvider interface for SAML/OIDC authentication.
|
Package sso defines the SSOProvider interface for SAML/OIDC authentication. |
|
Package storage defines the ObjectStore interface and its implementations.
|
Package storage defines the ObjectStore interface and its implementations. |
|
Package tags is the entity tag model: org-scoped tags, and the association between an entity — a page, a ticket, or a project item — and the tags it carries (migrations 040, 055).
|
Package tags is the entity tag model: org-scoped tags, and the association between an entity — a page, a ticket, or a project item — and the tags it carries (migrations 040, 055). |
|
Package teams implements the team grouping concept (ADR-0006): nested to five levels via a materialised path by ID, with an org default team that guarantees no user is ever teamless.
|
Package teams implements the team grouping concept (ADR-0006): nested to five levels via a materialised path by ID, with an org default team that guarantees no user is ever teamless. |
|
Package tickets implements the service desk domain: ticket lifecycle, email ingestion/egress, and kanban board queries.
|
Package tickets implements the service desk domain: ticket lifecycle, email ingestion/egress, and kanban board queries. |
|
Package views implements saved views (ADR-0009): named, reusable queries over Beacon tickets and Vector project items, stored as a query and never as results, resolved per viewer on every read.
|
Package views implements saved views (ADR-0009): named, reusable queries over Beacon tickets and Vector project items, stored as a query and never as results, resolved per viewer on every read. |
|
Package wiki implements wiki/docs: page tree, markdown rendering, version history, and conflict detection.
|
Package wiki implements wiki/docs: page tree, markdown rendering, version history, and conflict detection. |
|
doc
Package doc is the Codex document model: the ProseMirror-native document that migration 036 stores in pages.doc, and the machinery ADR-0012 requires around it.
|
Package doc is the Codex document model: the ProseMirror-native document that migration 036 stores in pages.doc, and the machinery ADR-0012 requires around it. |
|
Package workflow implements the workflow engine: state machines that govern how tickets and project items move through user-defined lifecycle states.
|
Package workflow implements the workflow engine: state machines that govern how tickets and project items move through user-defined lifecycle states. |
Click to show internal directories.
Click to hide internal directories.