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 cache;
19mod capability;
20mod clock;
21mod comment;
22mod error;
23mod guard;
24mod id;
25mod issue;
26mod metadata;
27mod metering;
28mod query;
29mod section;
30mod source;
31mod status_mapping;
32mod update;
33mod visibility;
34mod work;
35mod write;
36
37pub use asset::{
38    Asset, AssetContentType, AssetName, AssetPayload, AssetUpload, AssetUploads, AssetWrite,
39    AssetsWritten, asset_references, asset_sha256, assetless, body_digest, is_sha256,
40    rewrite_asset_references, serve_asset_references,
41};
42pub use cache::{
43    Coverage, DocumentVersionCoverage, JournalEntry, PartOutcome, ProjectVersionCoverage,
44    RequestKind, Shown, VersionCoverage, WholeTask, WriteJournal,
45};
46pub use capability::{Capabilities, DependencySupport, Support};
47pub use clock::{Clock, SIMULATED_CLOCK_VARIABLE, SharedClock, WaitCause, system_clock};
48pub use comment::{
49    Comment, CommentBody, CommentCopy, CommentOrigin, NewComment, TaskDetailRead, commentless,
50};
51pub use error::SourceError;
52pub use guard::WriteGuard;
53pub use id::{NativeId, SOURCE_NAME_PATTERN, SourceName};
54pub use issue::{
55    ClosedAs, Completion, ContradictedItem, HeldTask, ISSUE_REF_PATTERN, IssueHolding, IssueRef,
56    StatusContradiction,
57};
58pub use metadata::{MetadataKey, MetadataRecord, unwritable_metadata};
59pub use metering::{Metered, Metering};
60pub use query::{
61    Cursor, DocumentQuery, LabelFilter, MetadataMatch, Page, PageRequest, ProjectFilter,
62    ProjectQuery, TaskQuery, TextFields, TextQuery,
63};
64pub use section::{BodyMarkup, SharedBodyMarkup, StoredHeading};
65pub use source::{Health, SecretResolver, SourcePlugin, TaskSource};
66pub use status_mapping::{StatusMapping, StatusName, StatusNames, UnmappedStatus};
67pub use update::{TaskUpdate, TaskUpdateOutcome, UpdatedField};
68pub use visibility::{Visibility, WriteTarget};
69pub use work::{
70    Classification, DependencyEdge, DependencyEndpoint, DependencyKind, Designator, Direction,
71    Document, EndpointRefusal, ItemKind, Label, Location, Priority, Project, Repository, Status,
72    StatusCategory, Task, TaskRef,
73};
74pub use write::{ItemWrite, WriteSupport, documentless, unwritable, unwritable_field};
onetaskgraph_plugin_api/lib.rs

onetaskgraph_plugin_api/
lib.rs
