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 capability;
19mod clock;
20mod comment;
21mod error;
22mod id;
23mod metadata;
24mod metering;
25mod query;
26mod source;
27mod status_mapping;
28mod update;
29mod work;
30mod write;
31
32pub use asset::{
33    Asset, AssetContentType, AssetName, AssetPayload, AssetUpload, AssetUploads, AssetWrite,
34    AssetsWritten, asset_references, asset_sha256, assetless, body_digest, is_sha256,
35    rewrite_asset_references, serve_asset_references,
36};
37pub use capability::{Capabilities, DependencySupport, Support};
38pub use clock::{Clock, SIMULATED_CLOCK_VARIABLE, SharedClock, system_clock};
39pub use comment::{Comment, CommentBody, NewComment, TaskDetailRead, commentless};
40pub use error::SourceError;
41pub use id::{NativeId, SOURCE_NAME_PATTERN, SourceName};
42pub use metadata::{MetadataKey, MetadataRecord, unwritable_metadata};
43pub use metering::{Metered, Metering};
44pub use query::{
45    Cursor, DocumentQuery, LabelFilter, MetadataMatch, Page, PageRequest, ProjectFilter,
46    ProjectQuery, TaskQuery, TextFields, TextQuery,
47};
48pub use source::{Health, SecretResolver, SourcePlugin, TaskSource};
49pub use status_mapping::{StatusMapping, StatusName, StatusNames, UnmappedStatus};
50pub use update::{TaskUpdate, TaskUpdateOutcome, UpdatedField};
51pub use work::{
52    DependencyEdge, DependencyEndpoint, DependencyKind, Direction, Document, ItemKind, Label,
53    Location, Priority, Project, Repository, Status, StatusCategory, Task, TaskRef,
54};
55pub use write::{ItemWrite, WriteSupport, documentless, unwritable, unwritable_field};
onetaskgraph_plugin_api/lib.rs

onetaskgraph_plugin_api/
lib.rs
