apb 0.2.2

Traits and types to handle ActivityPub objects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! # apb
//! > traits and types for implementing [ActivityPub](https://www.w3.org/TR/activitypub/)
//!
//! The main type this crate exposes is the [Node], which can be:
//!  - [Node::Empty]: not present in object
//!  - [Node::Link]: contains just link to object
//!  - [Node::Object]: contains embedded object
//!  - [Node::Array]: contains array of embedded objects
//!
//! Nodes contain AP objects, which implement one or more traits (such as [Object] or [Actor])
//!
//! ## features
//! * `unstructured`: all traits are implemented for [serde_json::Value], so that it's possible to manipulate free-form json maps as valid AP objects
//! * `orm`: enum types are also database-friendly with sea-orm
//! * `fetch`: [Node] exposes [Node::fetch] to dereference remote nodes
//!
//! ## structure
//! - **[Base]** | **[BaseMut]** | [BaseType]
//!   - [BaseType::Link] | **[Link]** | **[LinkMut]** | [LinkType]
//!     - [LinkType::Mention]
//!     - [LinkType::Link]
//!   - [BaseType::Object] | **[Object]** | **[ObjectMut]** | [ObjectType]
//!     - [ObjectType::Activity] | **[Activity]** | **[ActivityMut]** | [ActivityType]
//!       - [ActivityType::Accept] | **[Accept]** | **[AcceptMut]** | [AcceptType]
//!         - [AcceptType::TentativeAccept]
//!       - [ActivityType::Add]
//!       - [ActivityType::Announce]
//!       - [ActivityType::Create]
//!       - [ActivityType::Delete]
//!       - [ActivityType::Dislike]
//!       - [ActivityType::Flag]
//!       - [ActivityType::Follow]
//!       - [ActivityType::IntransitiveActivity] | **[IntransitiveActivity]** | **[IntransitiveActivityMut]** | [IntransitiveActivityType]
//!         - [IntransitiveActivityType::IntransitiveActivity]
//!         - [IntransitiveActivityType::Arrive]
//!         - [IntransitiveActivityType::Question]
//!         - [IntransitiveActivityType::Travel]
//!       - [ActivityType::Ignore] | **[Ignore]** | **[IgnoreMut]** | [IgnoreType]
//!         - [IgnoreType::Ignore]
//!         - [IgnoreType::Block]
//!       - [ActivityType::Join]
//!       - [ActivityType::Leave]
//!       - [ActivityType::Like]
//!       - [ActivityType::Listen]
//!       - [ActivityType::Move]
//!       - [ActivityType::Offer] | **[Offer]** | **[OfferMut]** | [OfferType]
//!           - [OfferType::Offer]
//!           - [OfferType::Invite]
//!       - [ActivityType::Read]
//!       - [ActivityType::Reject] | **[Reject]** | **[RejectMut]** | [RejectType]
//!           - [RejectType::Reject]
//!           - [RejectType::TentativeReject]
//!       - [ActivityType::Remove]
//!       - [ActivityType::Undo]
//!       - [ActivityType::Update]
//!       - [ActivityType::View]
//!     - [ObjectType::Actor] | **[Actor]** | **[ActorMut]** | [ActorType] *
//!       - [ActorType::Application]
//!       - [ActorType::Group]
//!       - [ActorType::Organization]
//!       - [ActorType::Person]
//!     - [ObjectType::Article]
//!     - [ObjectType::Collection] | **[Collection]** | **[CollectionMut]** | [CollectionType]
//!       - [CollectionType::Collection]
//!       - [CollectionType::CollectionPage]
//!       - [CollectionType::OrderedCollection]
//!       - [CollectionType::OrderedCollectionPage]
//!     - [ObjectType::Document] | **[Document]** | **[DocumentMut]** | [DocumentType]
//!       - [DocumentType::Document]
//!       - [DocumentType::Audio]
//!       - [DocumentType::Image]
//!       - [DocumentType::Page]
//!       - [DocumentType::Video]
//!     - [ObjectType::Event]
//!     - [ObjectType::Note]
//!     - [ObjectType::Object]
//!     - [ObjectType::Place]
//!     - [ObjectType::Profile]
//!     - [ObjectType::Relationship]
//!     - [ObjectType::Tombstone]
//!   - **[PublicKey]** | **[PublicKeyMut]** \*\*
//!
//! *: `Actor` is technically just an object, not really a "subtype"
//!
//! **: `PublicKey` is introduced in ActivityPub, it's not part of ActivityStream
//!



mod macros;
pub(crate) use macros::strenum;

#[cfg(feature = "unstructured")]
pub(crate) use macros::{getter, setter};

mod node;
pub use node::Node;

pub mod target;

mod key;
pub use key::{PublicKey, PublicKeyMut};

pub mod field;
pub use field::{Field, FieldErr};

#[cfg(feature = "jsonld")]
mod jsonld;

#[cfg(feature = "jsonld")]
pub use jsonld::LD;

mod types;
pub use types::{
	base::{Base, BaseMut, BaseType},
	link::{Link, LinkMut, LinkType},
	object::{
		Object, ObjectMut, ObjectType,
		activity::{
			Activity, ActivityMut, ActivityType,
			accept::{Accept, AcceptMut, AcceptType},
			ignore::{Ignore, IgnoreMut, IgnoreType},
			intransitive::{IntransitiveActivity, IntransitiveActivityMut, IntransitiveActivityType},
			offer::{Offer, OfferMut, OfferType},
			reject::{Reject, RejectMut, RejectType},
		},
		actor::{Actor, ActorMut, ActorType, Endpoints, EndpointsMut},
		collection::{
			Collection, CollectionMut, CollectionType,
			page::{CollectionPage, CollectionPageMut}
		},
		document::{Document, DocumentMut, DocumentType},
		place::{Place, PlaceMut},
		profile::Profile,
		relationship::{Relationship, RelationshipMut},
		tombstone::{Tombstone, TombstoneMut},
	},
};

#[cfg(feature = "unstructured")]
pub fn new() -> serde_json::Value {
	serde_json::Value::Object(serde_json::Map::default())
}