@orakl/protocol 0.1.0

package/dist/pages/app.schema.js

@@ -0,0 +1,336 @@
+import { Schema } from "effect";
+import { MediaTypeSchema, QuestionSourceSchema } from "../question.schema.js";
+import { ThemeModeSchema, UserPowerSchema, UserRoleSchema, } from "./common.schema.js";
+/** Page-load response bodies for `src/api/routes/pages.ts`. */
+/** A JSON array, decoded mutable — Effect's `Schema.Array` types its `.Type`
+ *  as a `ReadonlyArray`, which every consumer here expects as a plain array. */
+function Arr(item) {
+    return Schema.mutable(Schema.Array(item));
+}
+/** Body of `GET /api/pages/home`. */
+export const HomePageSchema = Schema.Struct({
+    isLoggedIn: Schema.Boolean,
+    isCurator: Schema.Boolean,
+    host: Schema.NullOr(Schema.Struct({
+        badge: Schema.NullOr(Schema.String),
+        open: Schema.Boolean,
+    })),
+});
+/** Body of `POST /api/pages/billing/return`: the route to land the member on. */
+export const BillingReturnPageSchema = Schema.Struct({
+    route: Schema.String,
+});
+const CurationRequestSchema = Schema.Struct({
+    id: Schema.String,
+    user_id: Schema.String,
+    status: Schema.String,
+    created_at: Schema.String,
+});
+const SubscriptionRowSchema = Schema.Struct({
+    user_id: Schema.String,
+    provider: Schema.String,
+    provider_customer_id: Schema.String,
+    provider_subscription_id: Schema.NullOr(Schema.String),
+    status: Schema.String,
+    past_due_at: Schema.NullOr(Schema.String),
+    current_period_end: Schema.NullOr(Schema.String),
+    updated_at: Schema.String,
+});
+const HostingAllowanceSchema = Schema.Struct({
+    used: Schema.Number,
+    limit: Schema.Number,
+    left: Schema.Number,
+    entitled: Schema.Boolean,
+    unverified: Schema.Boolean,
+});
+const OrderBreakdownSchema = Schema.Struct({
+    vat: Schema.Number,
+    fee: Schema.Number,
+    net: Schema.Number,
+});
+/** Body of `GET /api/pages/profile`. */
+export const ProfilePageSchema = Schema.Struct({
+    user: Schema.Struct({
+        nickname: Schema.NullOr(Schema.String),
+        role: UserRoleSchema,
+        powers: Arr(UserPowerSchema),
+        avatar: Schema.String,
+        emailVerified: Schema.Boolean,
+    }),
+    theme: Schema.Struct({ mode: ThemeModeSchema }),
+    font: Schema.Literal("default", "dyslexic"),
+    pendingRequest: Schema.NullOr(CurationRequestSchema),
+    subscription: Schema.NullOr(SubscriptionRowSchema),
+    graceOver: Schema.Boolean,
+    allowance: Schema.NullOr(HostingAllowanceSchema),
+    breakdown: Schema.Struct({
+        exact: Schema.NullOr(Schema.Struct({
+            vat: Schema.Number,
+            fee: Schema.Number,
+            net: Schema.Number,
+            total: Schema.Number,
+        })),
+        estimate: Schema.Struct({
+            monthly: OrderBreakdownSchema,
+            lifetime: OrderBreakdownSchema,
+        }),
+    }),
+    welcome: Schema.NullOr(Schema.Literal("monthly", "lifetime")),
+    claimed: Schema.Boolean,
+    verified: Schema.Boolean,
+    tab: Schema.Literal("account", "appearance", "privacy", "tools"),
+    tools: Schema.Boolean,
+});
+const SessionDtoSchema = Schema.Struct({
+    sid: Schema.String,
+    fingerprint: Schema.String,
+    label: Schema.String,
+    createdAt: Schema.Number,
+    lastSeen: Schema.Number,
+    current: Schema.Boolean,
+    location: Schema.NullOr(Schema.String),
+});
+const LocationOptInSchema = Schema.Struct({
+    enabled: Schema.Boolean,
+    since: Schema.NullOr(Schema.Number),
+});
+/** Body of `GET /api/pages/profile/sessions`. */
+export const ProfileSessionsPageSchema = Schema.Struct({
+    sessions: Arr(SessionDtoSchema),
+    locationOptIn: LocationOptInSchema,
+});
+const AvatarRowSchema = Schema.Struct({
+    id: Schema.String,
+    title: Schema.String,
+    description: Schema.optional(Schema.String),
+    category: Schema.optional(Schema.String),
+    src: Schema.String,
+});
+/** Body of `GET /api/pages/manage/avatars`. */
+export const ManageAvatarsPageSchema = Schema.Struct({
+    sortedGroups: Arr(Schema.mutable(Schema.Tuple(Schema.String, Arr(AvatarRowSchema)))),
+    categories: Arr(Schema.String),
+});
+const CategorySchema = Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    description: Schema.NullOr(Schema.String),
+    icon: Schema.NullOr(Schema.String),
+    color: Schema.NullOr(Schema.String),
+    question_count: Schema.Number,
+});
+/** Body of `GET /api/pages/manage/categories`. */
+export const ManageCategoriesPageSchema = Schema.Struct({
+    initial: Arr(CategorySchema),
+});
+const AdminFlagRowSchema = Schema.Struct({
+    questionId: Schema.String,
+    excerpt: Schema.String,
+    categoryId: Schema.String,
+    flagCount: Schema.Number,
+    status: Schema.Literal("open", "resolved"),
+});
+/** Body of `GET /api/pages/manage/flagged-questions`. */
+export const ManageFlaggedQuestionsPageSchema = Schema.Struct({
+    initial: Arr(AdminFlagRowSchema),
+    initialHasMore: Schema.Boolean,
+    statusFilter: Schema.Literal("open", "resolved", "all"),
+    page: Schema.Number,
+});
+const AuthoredQuestionRowSchema = Schema.Struct({
+    id: Schema.String,
+    category: Schema.String,
+    label: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.NullOr(Schema.String),
+    created_by: Schema.NullOr(Schema.String),
+    author_nickname: Schema.NullOr(Schema.String),
+    author_email: Schema.NullOr(Schema.String),
+    published_at: Schema.NullOr(Schema.String),
+    published_by: Schema.NullOr(Schema.String),
+    unpublished_at: Schema.NullOr(Schema.String),
+    unpublished_by: Schema.NullOr(Schema.String),
+    unpublish_reason: Schema.NullOr(Schema.String),
+    changed_since_publish: Schema.Number,
+});
+/** Body of `GET /api/pages/manage/questions`. */
+export const ManageQuestionsPageSchema = Schema.Struct({
+    initial: Schema.Struct({
+        rows: Arr(AuthoredQuestionRowSchema),
+        total: Schema.Number,
+    }),
+    page: Schema.Number,
+    filters: Schema.Struct({
+        authorId: Schema.optional(Schema.String),
+        category: Schema.optional(Schema.String),
+        published: Schema.optional(Schema.Literal("all", "shared", "private")),
+        q: Schema.optional(Schema.String),
+        changed: Schema.optional(Schema.Boolean),
+    }),
+    authors: Arr(Schema.Struct({
+        id: Schema.String,
+        nickname: Schema.NullOr(Schema.String),
+        email: Schema.NullOr(Schema.String),
+        count: Schema.Number,
+    })),
+    categories: Arr(Schema.Struct({ id: Schema.String, name: Schema.String })),
+});
+/** Body of `GET /api/pages/manage/import`. */
+export const ManageImportPageSchema = Schema.Struct({
+    ok: Schema.Literal(true),
+});
+const CategoryOptionSchema = Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    icon: Schema.String,
+    count: Schema.Number,
+    color: Schema.String,
+});
+const QuizPresetSchema = Schema.Struct({
+    id: Schema.String,
+    curator_id: Schema.String,
+    name: Schema.String,
+    description: Schema.NullOr(Schema.String),
+    category_ids: Schema.String,
+    timer_duration: Schema.Number,
+    questions_per_round: Schema.Number,
+    difficulty: Schema.String,
+    advance_mode: Schema.String,
+    scoring_mode: Schema.NullOr(Schema.String),
+    access_mode: Schema.String,
+    max_players: Schema.NullOr(Schema.Number),
+    created_at: Schema.String,
+});
+/** Body of `GET /api/pages/curator/create`. */
+export const CuratorCreatePageSchema = Schema.Struct({
+    categories: Arr(CategoryOptionSchema),
+    categoryColors: Schema.Record({ key: Schema.String, value: Schema.String }),
+    presets: Arr(QuizPresetSchema),
+    presetLimit: Schema.Number,
+    subscription: Schema.NullOr(SubscriptionRowSchema),
+    allowance: HostingAllowanceSchema,
+});
+const GameHistoryListItemSchema = Schema.Struct({
+    id: Schema.String,
+    quiz_name: Schema.String,
+    started_at: Schema.String,
+    player_count: Schema.Number,
+    total_questions: Schema.Number,
+    winners: Arr(Schema.String),
+    top_score: Schema.NullOr(Schema.Number),
+});
+/** Body of `GET /api/pages/curator/history`. */
+export const CuratorHistoryPageSchema = Schema.Struct({
+    entries: Arr(GameHistoryListItemSchema),
+    nextCursor: Schema.NullOr(Schema.String),
+});
+const GameHistoryEntrySchema = Schema.Struct({
+    id: Schema.String,
+    quiz_name: Schema.String,
+    started_at: Schema.String,
+    ended_at: Schema.NullOr(Schema.String),
+    categoryIds: Arr(Schema.String),
+    timer_duration: Schema.Number,
+    total_questions: Schema.Number,
+    player_count: Schema.Number,
+    curator_id: Schema.NullOr(Schema.String),
+    difficulty: Schema.NullOr(Schema.String),
+    advance_mode: Schema.NullOr(Schema.String),
+    access_mode: Schema.NullOr(Schema.String),
+    max_players: Schema.NullOr(Schema.Number),
+    questions_per_round: Schema.NullOr(Schema.Number),
+    preset_id: Schema.NullOr(Schema.String),
+    stopped_at: Schema.NullOr(Schema.String),
+    planned_questions: Schema.NullOr(Schema.Number),
+});
+const GameHistoryResultSchema = Schema.Struct({
+    id: Schema.String,
+    player_nickname: Schema.String,
+    final_score: Schema.Number,
+    rank: Schema.Number,
+    player_id: Schema.NullOr(Schema.String),
+    user_id: Schema.NullOr(Schema.String),
+    avatar_id: Schema.NullOr(Schema.String),
+    role: Schema.NullOr(Schema.Literal("player", "observer")),
+    avatarSrc: Schema.String,
+});
+const AnswerSpreadEntrySchema = Schema.Struct({
+    answerId: Schema.String,
+    text: Schema.String,
+    count: Schema.Number,
+    correct: Schema.Boolean,
+});
+const QuestionRecapEntrySchema = Schema.Struct({
+    questionIndex: Schema.Number,
+    questionText: Schema.optional(Schema.String),
+    mediaUrl: Schema.optional(Schema.String),
+    mediaType: Schema.optional(MediaTypeSchema),
+    source: Schema.optional(QuestionSourceSchema),
+    postAnswerNote: Schema.optional(Schema.String),
+    answered: Schema.Number,
+    correct: Schema.Number,
+    spread: Schema.NullOr(Arr(AnswerSpreadEntrySchema)),
+    noAnswer: Schema.Number,
+});
+/** Body of `GET /api/pages/curator/history/:id`. */
+export const CuratorHistoryEntryPageSchema = Schema.Struct({
+    entry: Schema.Struct({
+        session: GameHistoryEntrySchema,
+        results: Arr(GameHistoryResultSchema),
+        questions: Schema.NullOr(Arr(QuestionRecapEntrySchema)),
+    }),
+    presetLimit: Schema.Number,
+    presetCount: Schema.Number,
+});
+const CuratorQuestionsCategoryOptionSchema = Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    icon: Schema.optional(Schema.String),
+    count: Schema.Number,
+});
+const OwnQuestionSchema = Schema.Struct({
+    id: Schema.String,
+    category: Schema.String,
+    label: Schema.String,
+    created_at: Schema.String,
+});
+/** Body of `GET /api/pages/curator/questions`. */
+export const CuratorQuestionsPageSchema = Schema.Struct({
+    categories: Arr(CuratorQuestionsCategoryOptionSchema),
+    ownQuestions: Arr(OwnQuestionSchema),
+    questionsCursor: Schema.NullOr(Schema.String),
+});
+/** Body of `GET /api/pages/solo/layout`. */
+export const SoloLayoutPageSchema = Schema.Struct({
+    isLoggedIn: Schema.Boolean,
+    isGuest: Schema.Boolean,
+    userId: Schema.String,
+    nickname: Schema.String,
+    profileAvatarSrc: Schema.String,
+    categoryDataJson: Schema.String,
+});
+const LeaderboardEntrySchema = Schema.Struct({
+    rank: Schema.Number,
+    user_id: Schema.String,
+    nickname: Schema.String,
+    total_score: Schema.Number,
+    correct_count: Schema.Number,
+    total_answered: Schema.Number,
+    time_to_answer_avg_ms: Schema.Number,
+    max_streak: Schema.Number,
+    completed_at: Schema.Number,
+});
+/** Body of `GET /api/pages/solo/leaderboard`. */
+export const SoloLeaderboardPageSchema = Schema.Struct({
+    entries: Arr(LeaderboardEntrySchema),
+    board: Schema.Literal("score", "streak", "accuracy", "speed", "survival"),
+    scope: Schema.Literal("all-time", "daily", "weekly", "monthly"),
+    categoryId: Schema.NullOr(Schema.String),
+    difficulty: Schema.NullOr(Schema.Literal("easy", "medium", "hard")),
+    categories: Arr(Schema.Struct({ id: Schema.String, name: Schema.String })),
+    userRank: Schema.NullOr(Schema.Number),
+    eligibleCount: Schema.Number,
+    percentile: Schema.NullOr(Schema.Number),
+    around: Schema.Boolean,
+    viewerId: Schema.NullOr(Schema.String),
+});

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

@@ -0,0 +1,25 @@
+import { Schema } from "effect";
+/** Page-load response bodies for `src/api/routes/auth.ts`. */
+/** Body of `GET /api/pages/auth/verify-email`: the address awaiting its code. */
+export declare const VerifyEmailPageSchema: Schema.Struct<{
+    email: typeof Schema.String;
+}>;
+/** Body of `GET /api/pages/auth/login`: whether a reset just landed here. */
+export declare const LoginPageSchema: Schema.Struct<{
+    resetSuccess: typeof Schema.Boolean;
+}>;
+/** Body of `GET /api/pages/auth/signup`: the claim-the-night prefill. */
+export declare const SignupPageSchema: Schema.Struct<{
+    claim: typeof Schema.Boolean;
+    prefillNickname: typeof Schema.String;
+}>;
+/** Body of `GET /api/pages/auth/forgot-password`: the form's prefill. */
+export declare const ForgotPasswordPageSchema: Schema.Struct<{
+    prefillEmail: typeof Schema.String;
+    sent: typeof Schema.Boolean;
+}>;
+/** Body of `GET /api/pages/auth/reset-password`: the token's validity. */
+export declare const ResetPasswordPageSchema: Schema.Struct<{
+    valid: typeof Schema.Boolean;
+    token: typeof Schema.String;
+}>;

package/dist/pages/auth.schema.js

@@ -0,0 +1,23 @@
+import { Schema } from "effect";
+/** Page-load response bodies for `src/api/routes/auth.ts`. */
+/** Body of `GET /api/pages/auth/verify-email`: the address awaiting its code. */
+export const VerifyEmailPageSchema = Schema.Struct({ email: Schema.String });
+/** Body of `GET /api/pages/auth/login`: whether a reset just landed here. */
+export const LoginPageSchema = Schema.Struct({
+    resetSuccess: Schema.Boolean,
+});
+/** Body of `GET /api/pages/auth/signup`: the claim-the-night prefill. */
+export const SignupPageSchema = Schema.Struct({
+    claim: Schema.Boolean,
+    prefillNickname: Schema.String,
+});
+/** Body of `GET /api/pages/auth/forgot-password`: the form's prefill. */
+export const ForgotPasswordPageSchema = Schema.Struct({
+    prefillEmail: Schema.String,
+    sent: Schema.Boolean,
+});
+/** Body of `GET /api/pages/auth/reset-password`: the token's validity. */
+export const ResetPasswordPageSchema = Schema.Struct({
+    valid: Schema.Boolean,
+    token: Schema.String,
+});

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

@@ -0,0 +1,27 @@
+import { Schema } from "effect";
+/** Schemas shared by more than one page-load body. */
+export declare const UserRoleSchema: Schema.Literal<["anonymous", "display", "member", "curator", "admin"]>;
+export declare const UserPowerSchema: Schema.Literal<["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"]>;
+export declare const SkyPhaseSchema: Schema.Literal<["night", "dawn", "morning", "noon", "evening", "sunset", "dusk"]>;
+export declare const ThemeModeSchema: Schema.Union<[Schema.Literal<["dark", "light", "system", "dynamic"]>, Schema.Literal<["night", "dawn", "morning", "noon", "evening", "sunset", "dusk"]>]>;
+export declare const PlayerRoleSchema: Schema.Literal<["player", "observer"]>;
+export declare const GameAnswerRecordSchema: Schema.Struct<{
+    questionIndex: typeof Schema.Number;
+    categoryId: typeof Schema.String;
+    difficulty: Schema.optional<Schema.Literal<["easy", "medium", "hard"]>>;
+    isCorrect: typeof Schema.Boolean;
+    timeToAnswerMs: typeof Schema.Number;
+    questionId: Schema.optional<typeof Schema.String>;
+    questionText: Schema.optional<typeof Schema.String>;
+    selectedAnswerId: Schema.optional<typeof Schema.String>;
+    selectedAnswerText: Schema.optional<typeof Schema.String>;
+    correctAnswerId: Schema.optional<typeof Schema.String>;
+    correctAnswerText: Schema.optional<typeof Schema.String>;
+    mediaUrl: Schema.optional<typeof Schema.String>;
+    mediaType: Schema.optional<Schema.Literal<["image", "audio", "video"]>>;
+    source: Schema.optional<Schema.Struct<{
+        url: Schema.filter<Schema.filter<typeof Schema.String>>;
+        label: Schema.optional<Schema.filter<typeof Schema.String>>;
+    }>>;
+    postAnswerNote: Schema.optional<typeof Schema.String>;
+}>;

package/dist/pages/common.schema.js

@@ -0,0 +1,28 @@
+import { Schema } from "effect";
+import { MediaTypeSchema, QuestionSourceSchema } from "../question.schema.js";
+/** Schemas shared by more than one page-load body. */
+export const UserRoleSchema = Schema.Literal("anonymous", "display", "member", "curator", "admin");
+export const UserPowerSchema = Schema.Literal("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");
+export const SkyPhaseSchema = Schema.Literal("night", "dawn", "morning", "noon", "evening", "sunset", "dusk");
+export const ThemeModeSchema = Schema.Union(Schema.Literal("dark", "light", "system", "dynamic"), SkyPhaseSchema);
+export const PlayerRoleSchema = Schema.Literal("player", "observer");
+export const GameAnswerRecordSchema = Schema.Struct({
+    questionIndex: Schema.Number,
+    categoryId: Schema.String,
+    difficulty: Schema.optional(Schema.Literal("easy", "medium", "hard")),
+    isCorrect: Schema.Boolean,
+    timeToAnswerMs: Schema.Number,
+    questionId: Schema.optional(Schema.String),
+    questionText: Schema.optional(Schema.String),
+    selectedAnswerId: Schema.optional(Schema.String),
+    selectedAnswerText: Schema.optional(Schema.String),
+    correctAnswerId: Schema.optional(Schema.String),
+    correctAnswerText: Schema.optional(Schema.String),
+    mediaUrl: Schema.optional(Schema.String),
+    mediaType: Schema.optional(MediaTypeSchema),
+    source: Schema.optional(QuestionSourceSchema),
+    postAnswerNote: Schema.optional(Schema.String),
+});
+// Assignability check: a schema drift that drops or mistypes a field the
+// hand-written GameAnswerRecord declares fails here at compile time.
+const _gameAnswerRecordCheck = null;