wayclip-core 0.1.4

Core module for the Wayclip ecosystem: models, settings, and methods for App
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
144
145
146
147
148
149
150
151

use crate::models::{
    clips::{
        games::Game,
        tags::{ClipsClipTagRequest, ClipsClipTagResponse},
    },
    nutype::{
        BitrateKbpsSanitised, ClipCommentContentSanitised, ClipDurationSanitised,
        ClipNameSanitised, FpsSanitised, ResolutionSanitised,
    },
};
use chrono::{DateTime, FixedOffset};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use strum_macros::Display;

/// The request to leave a new comment
#[derive(Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct ClipsNewCommentRequest {
    /// Content of comment
    pub content: ClipCommentContentSanitised,
    /// Parent ID of under what we are replying to
    pub parent_comment_id: Option<String>,
}

/// Data of a clip
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct ClipsResponse {
    /// Id of clip
    pub clip_id: String,
    /// Name of clip
    pub clip_name: String,
    /// Id of clip's owner
    pub user_id: String,
    /// Duration of clip in seconds
    pub duration_s: i32,
    /// Tags linked to clip
    pub tags: Vec<ClipsClipTagResponse>,
    /// Original resolution of clip
    pub resolution: Option<String>,
    /// Original bitrate of clip, in kbps
    pub bitrate_kbps: Option<i32>,
    /// Original fps of clip
    pub fps: Option<i32>,
    /// The upload status of clip
    pub status: ClipsStatusType,
    /// The original file size
    pub file_size_mb: i32,
    /// Time uploaded at
    pub uploaded_at: DateTime<FixedOffset>,
    /// Game assosciated with clip
    pub detected_game: Option<Game>,
    /// The location of the clip of user's choice
    pub location: String,
    /// Visibility of clip
    pub clip_visibility: ClipVisibility,
    /// Visibility/Access of comments
    pub comment_visibility: CommentVisibility,
    /// All reactions
    pub reactions: HashMap<String, i32>,
    /// Reaction count
    pub reaction_count: i32,
    /// View count
    pub view_count: i32,
}

/// An alias for ClipsResponse, to be used inside of APP
pub type HostedClip = ClipsResponse;

/// The upload status of clip as a whole
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Display)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub enum ClipsStatusType {
    /// When API created initial record
    Pending,
    /// `pre-create` hook: When user hits TUS for first time
    Uploading,
    /// `post-finish` hook: When user finished TUS upload
    Uploaded,
    /// Video has been trasncoded and moved to CLIPS_STORAGE_PATH
    Complete,
    /// Failed upload
    Failed,
}

/// Visibility of clip - who can see the clip
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Display)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub enum ClipVisibility {
    /// Public, everyone
    Public,
    /// Only owner
    Private,
    /// Everyone with the link
    Unlisted,
    /// Only mutual subscribers
    FriendsOnly,
}

/// The comment visibility - who can comment under a clip
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub enum CommentVisibility {
    /// Everyone can comment
    Everyone,
    /// Only mutual subscribers can comment
    FriendsOnly,
    /// No one can comment
    NoOne,
}

/// Metadata to be put into the multipart when uploading a clip
/// Every field here has to be sanitised via `nutype`
#[derive(Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct ClipsNewMetadata {
    /// The name of clip
    pub name: ClipNameSanitised,
    /// The duration
    pub duration_s: ClipDurationSanitised,
    /// The tags
    pub tags: Vec<ClipsClipTagRequest>,
    /// The original resolution
    pub resolution: Option<ResolutionSanitised>,
    /// The original bitrate
    pub bitrate_kbps: Option<BitrateKbpsSanitised>,
    /// The original fps
    pub fps: Option<FpsSanitised>,
    /// The visibility of clip
    pub clip_visibility: ClipVisibility,
    /// The game linked to clip
    pub detected_game: Option<Game>,
}

/// The request to be sent when patching a clip
/// Each field is `Option<T>` to make sure you can edit any single field at a time
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct PatchClipsClipIdRequest {
    /// Visibility of clip
    pub clip_visibility: Option<ClipVisibility>,
    /// Visibility of comments
    pub comment_visibility: Option<CommentVisibility>,
    /// Name of clip
    pub name: Option<ClipNameSanitised>,
    /// Tags of clip
    pub tags: Option<Vec<ClipsClipTagRequest>>,
    /// Game Type of clip
    pub detected_game: Option<Option<Game>>,
}