onetaskgraph_plugin_api/
lib.rs

1//! The contract every onetaskgraph source is written against.
2//!
3//! This crate holds exactly what a plugin author needs in order to implement a
4//! source, and nothing else: the two traits, the work types, the query and paging
5//! types, the capability declaration, and the error enum. The engine that drives
6//! sources lives in `onetaskgraph-core`, and **no plugin crate may depend on it**:
7//! `deny.toml` permits that crate exactly one wrapper, the binary, failing the
8//! required `deny` job, and `scripts/check-plugin-isolation.sh` reads the real
9//! `cargo metadata` graph inside `just check`.
10//!
11//! Keeping this crate still is the point. Every change here rebuilds and re-tests
12//! every plugin, which is exactly the cost the split exists to avoid paying on an
13//! ordinary engine change. When a new type could plausibly sit on either side, it
14//! belongs in `onetaskgraph-core` unless a trait signature names it.
15#![deny(missing_docs)]
16
17mod asset;
18mod batch;
19mod cache;
20mod capability;
21mod clock;
22mod comment;
23mod error;
24mod guard;
25mod held;
26mod id;
27mod issue;
28mod metadata;
29mod metering;
30mod query;
31mod relation;
32mod section;
33mod source;
34mod status_mapping;
35mod update;
36mod visibility;
37mod work;
38mod write;
39
40pub use asset::{
41    Asset, AssetContentType, AssetName, AssetPayload, AssetUpload, AssetUploads, AssetWrite,
42    AssetsWritten, asset_references, asset_sha256, assetless, body_digest, is_sha256,
43    rewrite_asset_references, serve_asset_references,
44};
45pub use batch::{BatchAnswer, BatchComment, BatchUpdate, decided_on, version_at};
46pub use cache::{
47    Coverage, DocumentVersionCoverage, JournalEntry, PartOutcome, ProjectVersionCoverage,
48    RequestKind, Shown, VersionCoverage, WholeTask, WriteJournal,
49};
50pub use capability::{Capabilities, DependencySupport, Support};
51pub use clock::{Clock, SIMULATED_CLOCK_VARIABLE, SharedClock, WaitCause, system_clock};
52pub use comment::{
53    AuthorKind, Comment, CommentBody, CommentCopy, CommentOrigin, NewComment, TaskDetailRead,
54    commentless,
55};
56pub use error::SourceError;
57pub use guard::WriteGuard;
58pub use held::HeldVersion;
59pub use id::{NativeId, SOURCE_NAME_PATTERN, SourceName};
60pub use issue::{
61    ClosedAs, Completion, ContradictedItem, HeldTask, ISSUE_REF_PATTERN, IssueHolding, IssueRef,
62    StatusContradiction,
63};
64pub use metadata::{MetadataKey, MetadataRecord, unwritable_metadata};
65pub use metering::{Metered, Metering};
66pub use query::{
67    Cursor, DocumentQuery, LabelFilter, MetadataMatch, Page, PageRequest, ProjectFilter,
68    ProjectQuery, TaskQuery, TextFields, TextQuery,
69};
70pub use relation::{
71    LINKS_HEADING, LinkDirection, LinkTypeConfig, LinkTypes, NativeLink, NativeWord, ParentAnswer,
72    ParentWrite, Relations, TaskLink, arrow, link_line, read_content, relationless, relinked,
73    strip_links_section, with_links_section,
74};
75pub use section::{BodyMarkup, SharedBodyMarkup, StoredHeading};
76pub use source::{Health, SecretResolver, SourcePlugin, TaskSource};
77pub use status_mapping::{StatusMapping, StatusName, StatusNames, UnmappedStatus};
78pub use update::{TaskUpdate, TaskUpdateOutcome, UpdatedField};
79pub use visibility::{Visibility, WriteTarget};
80pub use work::{
81    Classification, DependencyEdge, DependencyEndpoint, DependencyKind, Designator, Direction,
82    Document, EndpointRefusal, ItemKind, Label, Location, Priority, Project, Repository, Status,
83    StatusCategory, Task, TaskRef,
84};
85pub use write::{BodySize, ItemWrite, WriteSupport, documentless, unwritable, unwritable_field};
onetaskgraph_plugin_api/lib.rs

onetaskgraph_plugin_api/
lib.rs
