@orakl/protocol 0.1.0

package/dist/pages/app.schema.d.ts

@@ -0,0 +1,544 @@
+import { Schema } from "effect";
+/** Body of `GET /api/pages/home`. */
+export declare const HomePageSchema: Schema.Struct<{
+    isLoggedIn: typeof Schema.Boolean;
+    isCurator: typeof Schema.Boolean;
+    host: Schema.NullOr<Schema.Struct<{
+        badge: Schema.NullOr<typeof Schema.String>;
+        open: typeof Schema.Boolean;
+    }>>;
+}>;
+/** Body of `POST /api/pages/billing/return`: the route to land the member on. */
+export declare const BillingReturnPageSchema: Schema.Struct<{
+    route: typeof Schema.String;
+}>;
+/** Body of `GET /api/pages/profile`. */
+export declare const ProfilePageSchema: Schema.Struct<{
+    user: Schema.Struct<{
+        nickname: Schema.NullOr<typeof Schema.String>;
+        role: Schema.Literal<["anonymous", "display", "member", "curator", "admin"]>;
+        powers: Schema.mutable<Schema.Array$<Schema.Schema<"can-access-mimic" | "can-send-feedback" | "can-import-quizzes" | "can-manage-features" | "can-add-questions" | "can-manage-categories" | "can-moderate-questions" | "can-publish-questions" | "is-power-user" | "can-manage-avatars" | "can-apply-for-curation" | "can-1v1", "can-access-mimic" | "can-send-feedback" | "can-import-quizzes" | "can-manage-features" | "can-add-questions" | "can-manage-categories" | "can-moderate-questions" | "can-publish-questions" | "is-power-user" | "can-manage-avatars" | "can-apply-for-curation" | "can-1v1", never>>>;
+        avatar: typeof Schema.String;
+        emailVerified: typeof Schema.Boolean;
+    }>;
+    theme: Schema.Struct<{
+        mode: Schema.Union<[Schema.Literal<["dark", "light", "system", "dynamic"]>, Schema.Literal<["night", "dawn", "morning", "noon", "evening", "sunset", "dusk"]>]>;
+    }>;
+    font: Schema.Literal<["default", "dyslexic"]>;
+    pendingRequest: Schema.NullOr<Schema.Struct<{
+        id: typeof Schema.String;
+        user_id: typeof Schema.String;
+        status: typeof Schema.String;
+        created_at: typeof Schema.String;
+    }>>;
+    subscription: Schema.NullOr<Schema.Struct<{
+        user_id: typeof Schema.String;
+        provider: typeof Schema.String;
+        provider_customer_id: typeof Schema.String;
+        provider_subscription_id: Schema.NullOr<typeof Schema.String>;
+        status: typeof Schema.String;
+        past_due_at: Schema.NullOr<typeof Schema.String>;
+        current_period_end: Schema.NullOr<typeof Schema.String>;
+        updated_at: typeof Schema.String;
+    }>>;
+    graceOver: typeof Schema.Boolean;
+    allowance: Schema.NullOr<Schema.Struct<{
+        used: typeof Schema.Number;
+        limit: typeof Schema.Number;
+        left: typeof Schema.Number;
+        entitled: typeof Schema.Boolean;
+        unverified: typeof Schema.Boolean;
+    }>>;
+    breakdown: Schema.Struct<{
+        exact: Schema.NullOr<Schema.Struct<{
+            vat: typeof Schema.Number;
+            fee: typeof Schema.Number;
+            net: typeof Schema.Number;
+            total: typeof Schema.Number;
+        }>>;
+        estimate: Schema.Struct<{
+            monthly: Schema.Struct<{
+                vat: typeof Schema.Number;
+                fee: typeof Schema.Number;
+                net: typeof Schema.Number;
+            }>;
+            lifetime: Schema.Struct<{
+                vat: typeof Schema.Number;
+                fee: typeof Schema.Number;
+                net: typeof Schema.Number;
+            }>;
+        }>;
+    }>;
+    welcome: Schema.NullOr<Schema.Literal<["monthly", "lifetime"]>>;
+    claimed: typeof Schema.Boolean;
+    verified: typeof Schema.Boolean;
+    tab: Schema.Literal<["account", "appearance", "privacy", "tools"]>;
+    tools: typeof Schema.Boolean;
+}>;
+/** Body of `GET /api/pages/profile/sessions`. */
+export declare const ProfileSessionsPageSchema: Schema.Struct<{
+    sessions: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly location: string | null;
+        readonly label: string;
+        readonly createdAt: number;
+        readonly sid: string;
+        readonly fingerprint: string;
+        readonly lastSeen: number;
+        readonly current: boolean;
+    }, {
+        readonly location: string | null;
+        readonly label: string;
+        readonly createdAt: number;
+        readonly sid: string;
+        readonly fingerprint: string;
+        readonly lastSeen: number;
+        readonly current: boolean;
+    }, never>>>;
+    locationOptIn: Schema.Struct<{
+        enabled: typeof Schema.Boolean;
+        since: Schema.NullOr<typeof Schema.Number>;
+    }>;
+}>;
+/** Body of `GET /api/pages/manage/avatars`. */
+export declare const ManageAvatarsPageSchema: Schema.Struct<{
+    sortedGroups: Schema.mutable<Schema.Array$<Schema.Schema<[string, {
+        readonly src: string;
+        readonly id: string;
+        readonly title: string;
+        readonly description?: string | undefined;
+        readonly category?: string | undefined;
+    }[]], [string, {
+        readonly src: string;
+        readonly id: string;
+        readonly title: string;
+        readonly description?: string | undefined;
+        readonly category?: string | undefined;
+    }[]], never>>>;
+    categories: Schema.mutable<Schema.Array$<Schema.Schema<string, string, never>>>;
+}>;
+declare const CategorySchema: Schema.Struct<{
+    id: typeof Schema.String;
+    name: typeof Schema.String;
+    description: Schema.NullOr<typeof Schema.String>;
+    icon: Schema.NullOr<typeof Schema.String>;
+    color: Schema.NullOr<typeof Schema.String>;
+    question_count: typeof Schema.Number;
+}>;
+export type Category = typeof CategorySchema.Type;
+/** Body of `GET /api/pages/manage/categories`. */
+export declare const ManageCategoriesPageSchema: Schema.Struct<{
+    initial: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly name: string;
+        readonly id: string;
+        readonly color: string | null;
+        readonly description: string | null;
+        readonly icon: string | null;
+        readonly question_count: number;
+    }, {
+        readonly name: string;
+        readonly id: string;
+        readonly color: string | null;
+        readonly description: string | null;
+        readonly icon: string | null;
+        readonly question_count: number;
+    }, never>>>;
+}>;
+declare const AdminFlagRowSchema: Schema.Struct<{
+    questionId: typeof Schema.String;
+    excerpt: typeof Schema.String;
+    categoryId: typeof Schema.String;
+    flagCount: typeof Schema.Number;
+    status: Schema.Literal<["open", "resolved"]>;
+}>;
+/** One flagged-question row on the operator dashboard. */
+export type AdminFlagRow = typeof AdminFlagRowSchema.Type;
+/** Body of `GET /api/pages/manage/flagged-questions`. */
+export declare const ManageFlaggedQuestionsPageSchema: Schema.Struct<{
+    initial: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly status: "open" | "resolved";
+        readonly categoryId: string;
+        readonly questionId: string;
+        readonly excerpt: string;
+        readonly flagCount: number;
+    }, {
+        readonly status: "open" | "resolved";
+        readonly categoryId: string;
+        readonly questionId: string;
+        readonly excerpt: string;
+        readonly flagCount: number;
+    }, never>>>;
+    initialHasMore: typeof Schema.Boolean;
+    statusFilter: Schema.Literal<["open", "resolved", "all"]>;
+    page: typeof Schema.Number;
+}>;
+declare const AuthoredQuestionRowSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    category: typeof Schema.String;
+    label: typeof Schema.String;
+    created_at: typeof Schema.String;
+    updated_at: Schema.NullOr<typeof Schema.String>;
+    created_by: Schema.NullOr<typeof Schema.String>;
+    author_nickname: Schema.NullOr<typeof Schema.String>;
+    author_email: Schema.NullOr<typeof Schema.String>;
+    published_at: Schema.NullOr<typeof Schema.String>;
+    published_by: Schema.NullOr<typeof Schema.String>;
+    unpublished_at: Schema.NullOr<typeof Schema.String>;
+    unpublished_by: Schema.NullOr<typeof Schema.String>;
+    unpublish_reason: Schema.NullOr<typeof Schema.String>;
+    changed_since_publish: typeof Schema.Number;
+}>;
+/** One curator-authored question, with the author's identity. */
+export type AuthoredQuestionRow = typeof AuthoredQuestionRowSchema.Type;
+/** Body of `GET /api/pages/manage/questions`. */
+export declare const ManageQuestionsPageSchema: Schema.Struct<{
+    initial: Schema.Struct<{
+        rows: Schema.mutable<Schema.Array$<Schema.Schema<{
+            readonly id: string;
+            readonly label: string;
+            readonly category: string;
+            readonly created_at: string;
+            readonly updated_at: string | null;
+            readonly created_by: string | null;
+            readonly author_nickname: string | null;
+            readonly author_email: string | null;
+            readonly published_at: string | null;
+            readonly published_by: string | null;
+            readonly unpublished_at: string | null;
+            readonly unpublished_by: string | null;
+            readonly unpublish_reason: string | null;
+            readonly changed_since_publish: number;
+        }, {
+            readonly id: string;
+            readonly label: string;
+            readonly category: string;
+            readonly created_at: string;
+            readonly updated_at: string | null;
+            readonly created_by: string | null;
+            readonly author_nickname: string | null;
+            readonly author_email: string | null;
+            readonly published_at: string | null;
+            readonly published_by: string | null;
+            readonly unpublished_at: string | null;
+            readonly unpublished_by: string | null;
+            readonly unpublish_reason: string | null;
+            readonly changed_since_publish: number;
+        }, never>>>;
+        total: typeof Schema.Number;
+    }>;
+    page: typeof Schema.Number;
+    filters: Schema.Struct<{
+        authorId: Schema.optional<typeof Schema.String>;
+        category: Schema.optional<typeof Schema.String>;
+        published: Schema.optional<Schema.Literal<["all", "shared", "private"]>>;
+        q: Schema.optional<typeof Schema.String>;
+        changed: Schema.optional<typeof Schema.Boolean>;
+    }>;
+    authors: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly count: number;
+        readonly id: string;
+        readonly email: string | null;
+        readonly nickname: string | null;
+    }, {
+        readonly count: number;
+        readonly id: string;
+        readonly email: string | null;
+        readonly nickname: string | null;
+    }, never>>>;
+    categories: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly name: string;
+        readonly id: string;
+    }, {
+        readonly name: string;
+        readonly id: string;
+    }, never>>>;
+}>;
+/** How `listAuthored` narrows the row set: an exact author id, an exact
+ *  category name, shared or private, a literal search, edited-since-publish. */
+export type AuthoredQuestionFilters = (typeof ManageQuestionsPageSchema.Type)["filters"];
+/** Body of `GET /api/pages/manage/import`. */
+export declare const ManageImportPageSchema: Schema.Struct<{
+    ok: Schema.Literal<[true]>;
+}>;
+declare const QuizPresetSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    curator_id: typeof Schema.String;
+    name: typeof Schema.String;
+    description: Schema.NullOr<typeof Schema.String>;
+    category_ids: typeof Schema.String;
+    timer_duration: typeof Schema.Number;
+    questions_per_round: typeof Schema.Number;
+    difficulty: typeof Schema.String;
+    advance_mode: typeof Schema.String;
+    scoring_mode: Schema.NullOr<typeof Schema.String>;
+    access_mode: typeof Schema.String;
+    max_players: Schema.NullOr<typeof Schema.Number>;
+    created_at: typeof Schema.String;
+}>;
+export type QuizPreset = typeof QuizPresetSchema.Type;
+/** Body of `GET /api/pages/curator/create`. */
+export declare const CuratorCreatePageSchema: Schema.Struct<{
+    categories: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly name: string;
+        readonly count: number;
+        readonly id: string;
+        readonly color: string;
+        readonly icon: string;
+    }, {
+        readonly name: string;
+        readonly count: number;
+        readonly id: string;
+        readonly color: string;
+        readonly icon: string;
+    }, never>>>;
+    categoryColors: Schema.Record$<typeof Schema.String, typeof Schema.String>;
+    presets: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly name: string;
+        readonly id: string;
+        readonly description: string | null;
+        readonly difficulty: string;
+        readonly created_at: string;
+        readonly curator_id: string;
+        readonly category_ids: string;
+        readonly timer_duration: number;
+        readonly questions_per_round: number;
+        readonly advance_mode: string;
+        readonly scoring_mode: string | null;
+        readonly access_mode: string;
+        readonly max_players: number | null;
+    }, {
+        readonly name: string;
+        readonly id: string;
+        readonly description: string | null;
+        readonly difficulty: string;
+        readonly created_at: string;
+        readonly curator_id: string;
+        readonly category_ids: string;
+        readonly timer_duration: number;
+        readonly questions_per_round: number;
+        readonly advance_mode: string;
+        readonly scoring_mode: string | null;
+        readonly access_mode: string;
+        readonly max_players: number | null;
+    }, never>>>;
+    presetLimit: typeof Schema.Number;
+    subscription: Schema.NullOr<Schema.Struct<{
+        user_id: typeof Schema.String;
+        provider: typeof Schema.String;
+        provider_customer_id: typeof Schema.String;
+        provider_subscription_id: Schema.NullOr<typeof Schema.String>;
+        status: typeof Schema.String;
+        past_due_at: Schema.NullOr<typeof Schema.String>;
+        current_period_end: Schema.NullOr<typeof Schema.String>;
+        updated_at: typeof Schema.String;
+    }>>;
+    allowance: Schema.Struct<{
+        used: typeof Schema.Number;
+        limit: typeof Schema.Number;
+        left: typeof Schema.Number;
+        entitled: typeof Schema.Boolean;
+        unverified: typeof Schema.Boolean;
+    }>;
+}>;
+/** Body of `GET /api/pages/curator/history`. */
+export declare const CuratorHistoryPageSchema: Schema.Struct<{
+    entries: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly id: string;
+        readonly quiz_name: string;
+        readonly started_at: string;
+        readonly player_count: number;
+        readonly total_questions: number;
+        readonly winners: string[];
+        readonly top_score: number | null;
+    }, {
+        readonly id: string;
+        readonly quiz_name: string;
+        readonly started_at: string;
+        readonly player_count: number;
+        readonly total_questions: number;
+        readonly winners: string[];
+        readonly top_score: number | null;
+    }, never>>>;
+    nextCursor: Schema.NullOr<typeof Schema.String>;
+}>;
+declare const AnswerSpreadEntrySchema: Schema.Struct<{
+    answerId: typeof Schema.String;
+    text: typeof Schema.String;
+    count: typeof Schema.Number;
+    correct: typeof Schema.Boolean;
+}>;
+/** How many players picked one answer option. */
+export type AnswerSpreadEntry = typeof AnswerSpreadEntrySchema.Type;
+/** Body of `GET /api/pages/curator/history/:id`. */
+export declare const CuratorHistoryEntryPageSchema: Schema.Struct<{
+    entry: Schema.Struct<{
+        session: Schema.Struct<{
+            id: typeof Schema.String;
+            quiz_name: typeof Schema.String;
+            started_at: typeof Schema.String;
+            ended_at: Schema.NullOr<typeof Schema.String>;
+            categoryIds: Schema.mutable<Schema.Array$<Schema.Schema<string, string, never>>>;
+            timer_duration: typeof Schema.Number;
+            total_questions: typeof Schema.Number;
+            player_count: typeof Schema.Number;
+            curator_id: Schema.NullOr<typeof Schema.String>;
+            difficulty: Schema.NullOr<typeof Schema.String>;
+            advance_mode: Schema.NullOr<typeof Schema.String>;
+            access_mode: Schema.NullOr<typeof Schema.String>;
+            max_players: Schema.NullOr<typeof Schema.Number>;
+            questions_per_round: Schema.NullOr<typeof Schema.Number>;
+            preset_id: Schema.NullOr<typeof Schema.String>;
+            stopped_at: Schema.NullOr<typeof Schema.String>;
+            planned_questions: Schema.NullOr<typeof Schema.Number>;
+        }>;
+        results: Schema.mutable<Schema.Array$<Schema.Schema<{
+            readonly id: string;
+            readonly role: "player" | "observer" | null;
+            readonly user_id: string | null;
+            readonly player_nickname: string;
+            readonly final_score: number;
+            readonly rank: number;
+            readonly player_id: string | null;
+            readonly avatar_id: string | null;
+            readonly avatarSrc: string;
+        }, {
+            readonly id: string;
+            readonly role: "player" | "observer" | null;
+            readonly user_id: string | null;
+            readonly player_nickname: string;
+            readonly final_score: number;
+            readonly rank: number;
+            readonly player_id: string | null;
+            readonly avatar_id: string | null;
+            readonly avatarSrc: string;
+        }, never>>>;
+        questions: Schema.NullOr<Schema.mutable<Schema.Array$<Schema.Schema<{
+            readonly source?: {
+                readonly url: string;
+                readonly label?: string | undefined;
+            } | undefined;
+            readonly postAnswerNote?: string | undefined;
+            readonly questionIndex: number;
+            readonly questionText?: string | undefined;
+            readonly mediaUrl?: string | undefined;
+            readonly mediaType?: "audio" | "video" | "image" | undefined;
+            readonly correct: number;
+            readonly answered: number;
+            readonly spread: {
+                readonly count: number;
+                readonly text: string;
+                readonly answerId: string;
+                readonly correct: boolean;
+            }[] | null;
+            readonly noAnswer: number;
+        }, {
+            readonly questionIndex: number;
+            readonly correct: number;
+            readonly answered: number;
+            readonly spread: {
+                readonly count: number;
+                readonly text: string;
+                readonly answerId: string;
+                readonly correct: boolean;
+            }[] | null;
+            readonly noAnswer: number;
+            readonly source?: {
+                readonly url: string;
+                readonly label?: string | undefined;
+            } | undefined;
+            readonly postAnswerNote?: string | undefined;
+            readonly questionText?: string | undefined;
+            readonly mediaUrl?: string | undefined;
+            readonly mediaType?: "audio" | "video" | "image" | undefined;
+        }, never>>>>;
+    }>;
+    presetLimit: typeof Schema.Number;
+    presetCount: typeof Schema.Number;
+}>;
+/** Body of `GET /api/pages/curator/questions`. */
+export declare const CuratorQuestionsPageSchema: Schema.Struct<{
+    categories: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly name: string;
+        readonly count: number;
+        readonly id: string;
+        readonly icon?: string | undefined;
+    }, {
+        readonly name: string;
+        readonly count: number;
+        readonly id: string;
+        readonly icon?: string | undefined;
+    }, never>>>;
+    ownQuestions: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly id: string;
+        readonly label: string;
+        readonly category: string;
+        readonly created_at: string;
+    }, {
+        readonly id: string;
+        readonly label: string;
+        readonly category: string;
+        readonly created_at: string;
+    }, never>>>;
+    questionsCursor: Schema.NullOr<typeof Schema.String>;
+}>;
+/** Body of `GET /api/pages/solo/layout`. */
+export declare const SoloLayoutPageSchema: Schema.Struct<{
+    isLoggedIn: typeof Schema.Boolean;
+    isGuest: typeof Schema.Boolean;
+    userId: typeof Schema.String;
+    nickname: typeof Schema.String;
+    profileAvatarSrc: typeof Schema.String;
+    categoryDataJson: typeof Schema.String;
+}>;
+declare const LeaderboardEntrySchema: Schema.Struct<{
+    rank: typeof Schema.Number;
+    user_id: typeof Schema.String;
+    nickname: typeof Schema.String;
+    total_score: typeof Schema.Number;
+    correct_count: typeof Schema.Number;
+    total_answered: typeof Schema.Number;
+    time_to_answer_avg_ms: typeof Schema.Number;
+    max_streak: typeof Schema.Number;
+    completed_at: typeof Schema.Number;
+}>;
+export type LeaderboardEntry = typeof LeaderboardEntrySchema.Type;
+/** Body of `GET /api/pages/solo/leaderboard`. */
+export declare const SoloLeaderboardPageSchema: Schema.Struct<{
+    entries: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly user_id: string;
+        readonly nickname: string;
+        readonly rank: number;
+        readonly total_score: number;
+        readonly correct_count: number;
+        readonly total_answered: number;
+        readonly time_to_answer_avg_ms: number;
+        readonly max_streak: number;
+        readonly completed_at: number;
+    }, {
+        readonly user_id: string;
+        readonly nickname: string;
+        readonly rank: number;
+        readonly total_score: number;
+        readonly correct_count: number;
+        readonly total_answered: number;
+        readonly time_to_answer_avg_ms: number;
+        readonly max_streak: number;
+        readonly completed_at: number;
+    }, never>>>;
+    board: Schema.Literal<["score", "streak", "accuracy", "speed", "survival"]>;
+    scope: Schema.Literal<["all-time", "daily", "weekly", "monthly"]>;
+    categoryId: Schema.NullOr<typeof Schema.String>;
+    difficulty: Schema.NullOr<Schema.Literal<["easy", "medium", "hard"]>>;
+    categories: Schema.mutable<Schema.Array$<Schema.Schema<{
+        readonly name: string;
+        readonly id: string;
+    }, {
+        readonly name: string;
+        readonly id: string;
+    }, never>>>;
+    userRank: Schema.NullOr<typeof Schema.Number>;
+    eligibleCount: typeof Schema.Number;
+    percentile: Schema.NullOr<typeof Schema.Number>;
+    around: typeof Schema.Boolean;
+    viewerId: Schema.NullOr<typeof Schema.String>;
+}>;
+export {};