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

onetaskgraph_plugin_api/
lib.rs
