activitystreams 0.6.2

/*
 * This file is part of ActivityStreams.
 *
 * Copyright © 2020 Riley Trautman
 *
 * ActivityStreams is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ActivityStreams is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ActivityStreams.  If not, see <http://www.gnu.org/licenses/>.
 */

//! Namespace for properties of standard Actor types
//!
//! To use these properties in your own types, you can flatten them into your struct with serde:
//!
//! ```rust
//! use activitystreams::{
//!     actor::{
//!         properties::ApActorProperties,
//!         Actor, ActorBox,
//!     },
//!     ext::Ext,
//!     object::{
//!         properties::{ApObjectProperties, ObjectProperties},
//!         Object, ObjectBox,
//!     },
//!     Base, BaseBox, PropRefs,
//! };
//! use serde::{Deserialize, Serialize};
//!
//! #[derive(Clone, Debug, Default, serde::Serialize, serde::Deserialize)]
//! #[serde(transparent)]
//! pub struct ObjProps(pub ObjectProperties);
//!
//! #[derive(Clone, Debug, Default, serde::Serialize, serde::Deserialize)]
//! #[serde(transparent)]
//! pub struct ApObjProps(pub ApObjectProperties);
//!
//! #[derive(Clone, Debug, Default, serde::Serialize, serde::Deserialize)]
//! #[serde(transparent)]
//! pub struct ApActorProps(pub ApActorProperties);
//!
//! #[derive(Clone, Debug, Default, Serialize, Deserialize, PropRefs)]
//! #[serde(rename_all = "camelCase")]
//! #[prop_refs(Object)]
//! #[prop_refs(Actor)]
//! pub struct MyActor {
//!     #[serde(rename = "type")]
//!     pub kind: String,
//!
//!     /// Define a require property for the MyActor type
//!     pub my_property: String,
//!
//!     #[serde(flatten)]
//!     #[prop_refs]
//!     pub object_props: ObjProps,
//!
//!     #[serde(flatten)]
//!     #[prop_refs]
//!     pub ap_object_props: ApObjProps,
//!
//!     #[serde(flatten)]
//!     #[prop_refs]
//!     pub actor_props: ApActorProps,
//! }
//! #
//! # fn main() {}
//! ```

use crate::{
    actor::Actor,
    endpoint::EndpointProperties,
    ext::Extension,
    primitives::{XsdAnyUri, XsdString},
    properties,
};

impl<T> Extension<T> for ApActorProperties where T: Actor {}

properties! {
    ApActor {
        docs [
            "Define activitypub properties for the Actor type as described by the Activity Pub vocabulary."
        ],

        inbox {
            docs [
                "A reference to an [[ActivityStreams](https://www.w3.org/ns/activitystreams)]",
                "OrderedCollection comprised of all the messages received by the actor.",
                "",
                "- Range: `xsd:anyUri`",
                "- Functional: true",
            ],
            types [ XsdAnyUri ],
            functional,
            required,
        },

        outbox {
            docs [
                "An [ActivityStreams](https://www.w3.org/ns/activitystreams)] OrderedCollection comprised of",
                "all the messages produced by the actor.",
                "",
                "- Range: `xsd:anyUri`",
                "- Functional: true",
            ],
            types [ XsdAnyUri ],
            functional,
            required,
        },

        following {
            docs [
                "A link to an [[ActivityStreams](https://www.w3.org/ns/activitystreams)] collection of the",
                "actors that this actor is following.",
                "",
                "- Range: `xsd:anyUri`",
                "- Functional: true",
            ],
            types [ XsdAnyUri ],
            functional,
        },

        followers {
            docs [
                "A link to an [[ActivityStreams](https://www.w3.org/ns/activitystreams)] collection of the",
                "actors that follow this actor.",
                "",
                "- Range: `xsd:anyUri`",
                "- Functional: true",
            ],
            types [ XsdAnyUri ],
            functional,
        },

        liked {
            docs [
                "A link to an [[ActivityStreams](https://www.w3.org/ns/activitystreams)] collection of",
                "objects this actor has liked.",
                "",
                "- Range: `xsd:anyUri`",
                "- Functional: true",
            ],
            types [ XsdAnyUri ],
            functional,
        },

        streams {
            docs [
                "A list of supplementary Collections which may be of interest.",
                "",
                "- Range: `xsd:anyUri`",
                "- Functional: false",
            ],
            types [ XsdAnyUri ],
        },

        preferred_username {
            docs [
                "A short username which may be used to refer to the actor, with no uniqueness guarantees.",
                "",
                "- Range: `xsd:string`",
                "- Functional: true",
            ],
            types [ XsdString ],
            functional,
        },

        endpoints {
            docs [
                "A json object which maps additional (typically server/domain-wide) endpoints which may be",
                "useful either for this actor or someone referencing this actor.",
                "",
                "This mapping may be nested inside the actor document as the value or may be a link to a",
                "JSON-LD document with these properties.",
                "",
                "- Range: `Endpoint`",
                "- Functional: true",
            ],
            types [ EndpointProperties ],
            functional,
        },
    }
}