@omniplex/api-types 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +81 -0
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -25,6 +25,8 @@ export interface AssetVersions {
25
25
  banner?: string;
26
26
  }
27
27
  export interface IndexBot {
28
+ /** Views in the last 30 days, counting each visitor once per listing per day. */
29
+ views_30d?: number;
28
30
  asset_versions?: AssetVersions;
29
31
  highlighted?: boolean;
30
32
  card_color?: string;
@@ -44,6 +46,8 @@ export interface IndexBot {
44
46
  invite_clicks: number;
45
47
  clicks: number;
46
48
  servers: number;
49
+ /** Stats the owner chose to hide. Hidden stats are returned as zero unless you manage this listing. */
50
+ hidden_stats?: string[];
47
51
  nsfw: boolean;
48
52
  tags: string[];
49
53
  premium: boolean;
@@ -54,6 +58,8 @@ export interface IndexBot {
54
58
  spotlighted_until: string | null;
55
59
  }
56
60
  export interface Bot {
61
+ /** Views in the last 30 days, counting each visitor once per listing per day. */
62
+ views_30d?: number;
57
63
  asset_versions?: AssetVersions;
58
64
  itag: string;
59
65
  bot_id: string;
@@ -85,6 +91,10 @@ export interface Bot {
85
91
  /** Successful uptime checks out of total_uptime, from Popplio's periodic presence check. */
86
92
  uptime: number;
87
93
  total_uptime: number;
94
+ /** Share of uptime checks in the last 30 days where the bot was online, 0 to 100. Null when it hasn't been seen online in that time. */
95
+ uptime_percent?: number | null;
96
+ /** How many uptime checks ran in the last 30 days. */
97
+ uptime_checks?: number;
88
98
  /** Null if never checked yet. */
89
99
  uptime_last_checked: string | null;
90
100
  prefix: string;
@@ -93,6 +103,8 @@ export interface Bot {
93
103
  cert_reason: string | null;
94
104
  captcha_opt_out: boolean;
95
105
  auto_votes_opt_out?: boolean;
106
+ /** Stats the owner chose to hide. Hidden stats are returned as zero unless you manage this listing. */
107
+ hidden_stats?: string[];
96
108
  auto_votes?: number;
97
109
  highlighted?: boolean;
98
110
  card_color?: string;
@@ -223,6 +235,10 @@ export interface RecentChangelogBot {
223
235
  }
224
236
  export type ServerState = "public" | "private" | "unlisted" | "defunct";
225
237
  export interface IndexServer {
238
+ /** Views in the last 30 days, counting each visitor once per listing per day. */
239
+ views_30d?: number;
240
+ /** Stats the owner chose to hide. Hidden stats are returned as zero unless you manage this listing. */
241
+ hidden_stats?: string[];
226
242
  asset_versions?: AssetVersions;
227
243
  highlighted?: boolean;
228
244
  card_color?: string;
@@ -994,6 +1010,53 @@ export interface ListIndexServer {
994
1010
  spotlight: IndexServer[];
995
1011
  recently_bumped?: IndexServer[];
996
1012
  }
1013
+ export type PageGradient = "aurora" | "sunset" | "ocean" | "forest" | "candy" | "midnight" | "ember" | "mono";
1014
+ export interface PageStyle {
1015
+ gradient: PageGradient | null;
1016
+ accent: string | null;
1017
+ image_version: string | null;
1018
+ dim: number;
1019
+ blur: number;
1020
+ image_position: "top" | "center" | "bottom";
1021
+ fixed: boolean;
1022
+ }
1023
+ export interface ManagedPageStyle extends PageStyle {
1024
+ premium: boolean;
1025
+ unlocked_until: string | null;
1026
+ pending_version: string | null;
1027
+ pending_since: string | null;
1028
+ rejected_reason: string | null;
1029
+ }
1030
+ export interface PageStyleUpdate {
1031
+ gradient: PageGradient | null;
1032
+ accent: string | null;
1033
+ dim: number;
1034
+ blur: number;
1035
+ image_position: "top" | "center" | "bottom";
1036
+ fixed: boolean;
1037
+ remove_image?: boolean;
1038
+ }
1039
+ export interface StatsHistoryMonth {
1040
+ month: string;
1041
+ votes: number | null;
1042
+ voters: number | null;
1043
+ approved: number | null;
1044
+ denied: number | null;
1045
+ new_bots: number;
1046
+ new_servers: number;
1047
+ new_users: number | null;
1048
+ }
1049
+ export interface StatsHistory {
1050
+ votes_all_time: number;
1051
+ votes_this_month: number;
1052
+ voters_all_time: number;
1053
+ votes_since: string | null;
1054
+ approvals: number;
1055
+ denials: number;
1056
+ reviews_since: string | null;
1057
+ months: StatsHistoryMonth[];
1058
+ generated_at: string;
1059
+ }
997
1060
  export interface ListStats {
998
1061
  total_bots: number;
999
1062
  total_approved_bots: number;
@@ -1014,12 +1077,24 @@ export interface ListStats {
1014
1077
  total_denied_servers: number;
1015
1078
  total_vote_banned_servers: number;
1016
1079
  }
1080
+ export type AppQuestionType = "short" | "long" | "choice" | "multi" | "yesno" | "number" | "url" | "rating";
1081
+ export interface AppQuestionCondition {
1082
+ question_id: string;
1083
+ values: string[];
1084
+ }
1017
1085
  export interface AppQuestion {
1018
1086
  id: string;
1019
1087
  question: string;
1020
1088
  paragraph: string;
1021
1089
  placeholder: string;
1022
1090
  short: boolean;
1091
+ type?: AppQuestionType;
1092
+ options?: string[];
1093
+ optional?: boolean;
1094
+ min_length?: number;
1095
+ max_length?: number;
1096
+ show_if?: AppQuestionCondition | null;
1097
+ flag?: string[];
1023
1098
  }
1024
1099
  export interface AppPosition {
1025
1100
  id: string;
@@ -1122,6 +1197,10 @@ export interface BoosterPerkTarget {
1122
1197
  name: string;
1123
1198
  avatar: string;
1124
1199
  }
1200
+ export interface SitePrefs {
1201
+ prefs: Record<string, unknown>;
1202
+ updated_at: string | null;
1203
+ }
1125
1204
  export interface BoosterPerks {
1126
1205
  boosting: boolean;
1127
1206
  in_server: boolean;
@@ -1523,6 +1602,7 @@ export interface BotSettingsUpdate {
1523
1602
  nsfw: boolean;
1524
1603
  captcha_opt_out: boolean;
1525
1604
  auto_votes_opt_out?: boolean;
1605
+ hidden_stats?: string[];
1526
1606
  card_color?: string;
1527
1607
  }
1528
1608
  export interface ServerSettingsUpdate {
@@ -1534,6 +1614,7 @@ export interface ServerSettingsUpdate {
1534
1614
  nsfw: boolean;
1535
1615
  captcha_opt_out: boolean;
1536
1616
  auto_votes_opt_out?: boolean;
1617
+ hidden_stats?: string[];
1537
1618
  card_color?: string;
1538
1619
  login_required_for_invite: boolean;
1539
1620
  show_emojis: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@omniplex/api-types",
3
- "version": "0.3.0",
3
+ "version": "0.5.0",
4
4
  "description": "TypeScript types for the Omniplex API (Popplio).",
5
5
  "license": "MIT",
6
6
  "type": "module",