@orakl/protocol 0.1.0 → 0.2.0

package/dist/badges.d.ts

@@ -1,4 +1,4 @@
-export type BadgeId = "victor" | "flawless" | "sharpshooter" | "podium" | "unstoppable" | "on-a-roll" | "survivor" | "giant-slayer" | "pantheon" | "specialist" | "polymath" | "phoenix" | "strong-finish" | "master-of-none" | "faster-than-most" | "clutch" | "quick-draw" | "decisive" | "sure-handed" | "unbroken-focus" | "devotee";
+export type BadgeId = "victor" | "flawless" | "sharpshooter" | "podium" | "unstoppable" | "on-a-roll" | "survivor" | "giant-slayer" | "pantheon" | "specialist" | "polymath" | "phoenix" | "strong-finish" | "master-of-none" | "faster-than-most" | "clutch" | "quick-draw" | "decisive" | "sure-handed" | "unbroken-focus" | "devotee" | "herculean" | "undaunted" | "measured" | "strong-start" | "new-heights" | "far-horizons" | "cassandra" | "lone-torch" | "ascendant" | "undisputed";
 /** Modes a badge can be awarded in. */
 export type BadgeMode = "solo" | "multiplayer";
 export interface BadgeAward {

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

@@ -441,10 +441,7 @@ export declare const CuratorHistoryEntryPageSchema: Schema.Struct<{
                 readonly correct: boolean;
             }[] | null;
             readonly noAnswer: number;
-            readonly source?: {
-                readonly url: string;
-                readonly label?: string | undefined;
-            } | undefined;
+            readonly source?: unknown;
             readonly postAnswerNote?: string | undefined;
             readonly questionText?: string | undefined;
             readonly mediaUrl?: string | undefined;

package/dist/pages/app.schema.js

@@ -1,5 +1,5 @@
 import { Schema } from "effect";
-import { MediaTypeSchema, QuestionSourceSchema } from "../question.schema.js";
+import { MediaTypeSchema, StoredQuestionSourceSchema, } 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`
@@ -265,7 +265,7 @@ const QuestionRecapEntrySchema = Schema.Struct({
     questionText: Schema.optional(Schema.String),
     mediaUrl: Schema.optional(Schema.String),
     mediaType: Schema.optional(MediaTypeSchema),
-    source: Schema.optional(QuestionSourceSchema),
+    source: Schema.optional(StoredQuestionSourceSchema),
     postAnswerNote: Schema.optional(Schema.String),
     answered: Schema.Number,
     correct: Schema.Number,

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

@@ -19,9 +19,12 @@ export declare const GameAnswerRecordSchema: Schema.Struct<{
     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>>;
-    }>>;
+    source: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+        readonly url: string;
+        readonly label?: string | undefined;
+    }, {
+        readonly url: string;
+        readonly label?: string | undefined;
+    }, never>>>>;
     postAnswerNote: Schema.optional<typeof Schema.String>;
 }>;

package/dist/pages/common.schema.js

@@ -1,5 +1,5 @@
 import { Schema } from "effect";
-import { MediaTypeSchema, QuestionSourceSchema } from "../question.schema.js";
+import { MediaTypeSchema, StoredQuestionSourceSchema, } 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");
@@ -20,7 +20,7 @@ export const GameAnswerRecordSchema = Schema.Struct({
     correctAnswerText: Schema.optional(Schema.String),
     mediaUrl: Schema.optional(Schema.String),
     mediaType: Schema.optional(MediaTypeSchema),
-    source: Schema.optional(QuestionSourceSchema),
+    source: Schema.optional(StoredQuestionSourceSchema),
     postAnswerNote: Schema.optional(Schema.String),
 });
 // Assignability check: a schema drift that drops or mistypes a field the

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

@@ -1,7 +1,7 @@
 import { Schema } from "effect";
 /** Page-load response bodies for `src/api/routes/pages-history.ts and admin-feature-flags.ts`. */
 /** Achievement badge id (mirrors `BadgeId` in `src/lib/badges.ts`). */
-export declare const BadgeIdSchema: Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee"]>;
+export declare const BadgeIdSchema: Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee", "herculean", "undaunted", "measured", "strong-start", "new-heights", "far-horizons", "cassandra", "lone-torch", "ascendant", "undisputed"]>;
 /** Rarity tier a badge award reached (mirrors `Rarity` in `src/lib/badges.ts`). */
 export declare const RaritySchema: Schema.Literal<["common", "rare", "legendary", "exotic"]>;
 /** Per-badge counts + best rarity across a player's runs (mirrors `BadgeTally`). */
@@ -89,7 +89,7 @@ declare const PlayerGamePlacementSchema: Schema.Struct<{
     final_score: typeof Schema.Number;
     rank: typeof Schema.Number;
     player_count: typeof Schema.Number;
-    badges: Schema.mutable<Schema.Array$<Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee"]>>>;
+    badges: Schema.mutable<Schema.Array$<Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee", "herculean", "undaunted", "measured", "strong-start", "new-heights", "far-horizons", "cassandra", "lone-torch", "ascendant", "undisputed"]>>>;
 }>;
 export type PlayerGamePlacement = typeof PlayerGamePlacementSchema.Type;
 /** Body of `GET /api/pages/history`. */
@@ -164,7 +164,7 @@ export declare const HistoryPageSchema: Schema.Struct<{
         final_score: typeof Schema.Number;
         rank: typeof Schema.Number;
         player_count: typeof Schema.Number;
-        badges: Schema.mutable<Schema.Array$<Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee"]>>>;
+        badges: Schema.mutable<Schema.Array$<Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee", "herculean", "undaunted", "measured", "strong-start", "new-heights", "far-horizons", "cassandra", "lone-torch", "ascendant", "undisputed"]>>>;
     }>>>;
     runsNextCursor: Schema.NullOr<typeof Schema.String>;
     gamesNextCursor: Schema.NullOr<typeof Schema.String>;
@@ -190,7 +190,7 @@ export declare const GameReviewPageSchema: Schema.Struct<{
         avatarSrc: typeof Schema.String;
     }>>>;
     badges: Schema.mutable<Schema.Array$<Schema.Struct<{
-        id: Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee"]>;
+        id: Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee", "herculean", "undaunted", "measured", "strong-start", "new-heights", "far-horizons", "cassandra", "lone-torch", "ascendant", "undisputed"]>;
         rarity: Schema.Literal<["common", "rare", "legendary", "exotic"]>;
     }>>>;
     breakdown: Schema.NullOr<Schema.mutable<Schema.Array$<Schema.Struct<{
@@ -207,10 +207,13 @@ export declare const GameReviewPageSchema: Schema.Struct<{
         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>>;
-        }>>;
+        source: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+            readonly url: string;
+            readonly label?: string | undefined;
+        }, {
+            readonly url: string;
+            readonly label?: string | undefined;
+        }, never>>>>;
         postAnswerNote: Schema.optional<typeof Schema.String>;
     }>>>>;
     categoryName: Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>;
@@ -237,7 +240,7 @@ export declare const SoloReviewPageSchema: Schema.Struct<{
         categories: Schema.mutable<Schema.Array$<typeof Schema.String>>;
     }>;
     badges: Schema.mutable<Schema.Array$<Schema.Struct<{
-        id: Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee"]>;
+        id: Schema.Literal<["victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee", "herculean", "undaunted", "measured", "strong-start", "new-heights", "far-horizons", "cassandra", "lone-torch", "ascendant", "undisputed"]>;
         rarity: Schema.Literal<["common", "rare", "legendary", "exotic"]>;
     }>>>;
     categoryStats: Schema.mutable<Schema.Array$<Schema.Struct<{
@@ -258,10 +261,13 @@ export declare const SoloReviewPageSchema: Schema.Struct<{
         questionId: Schema.NullOr<typeof Schema.String>;
         mediaUrl: Schema.NullOr<typeof Schema.String>;
         mediaType: Schema.NullOr<Schema.Literal<["image", "audio", "video"]>>;
-        source: Schema.NullOr<Schema.Struct<{
-            url: Schema.filter<Schema.filter<typeof Schema.String>>;
-            label: Schema.optional<Schema.filter<typeof Schema.String>>;
-        }>>;
+        source: Schema.Union<[typeof Schema.Null, Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+            readonly url: string;
+            readonly label?: string | undefined;
+        }, {
+            readonly url: string;
+            readonly label?: string | undefined;
+        }, never>>>]>;
         postAnswerNote: Schema.NullOr<typeof Schema.String>;
     }>>>;
     alreadyFlaggedIds: Schema.mutable<Schema.Array$<typeof Schema.String>>;

package/dist/pages/history.schema.js

@@ -1,9 +1,9 @@
 import { Schema } from "effect";
-import { MediaTypeSchema, QuestionSourceSchema } from "../question.schema.js";
+import { MediaTypeSchema, StoredQuestionSourceSchema, } from "../question.schema.js";
 import { GameAnswerRecordSchema, PlayerRoleSchema, UserPowerSchema, UserRoleSchema, } from "./common.schema.js";
 /** Page-load response bodies for `src/api/routes/pages-history.ts and admin-feature-flags.ts`. */
 /** Achievement badge id (mirrors `BadgeId` in `src/lib/badges.ts`). */
-export const BadgeIdSchema = Schema.Literal("victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee");
+export const BadgeIdSchema = Schema.Literal("victor", "flawless", "sharpshooter", "podium", "unstoppable", "on-a-roll", "survivor", "giant-slayer", "pantheon", "specialist", "polymath", "phoenix", "strong-finish", "master-of-none", "faster-than-most", "clutch", "quick-draw", "decisive", "sure-handed", "unbroken-focus", "devotee", "herculean", "undaunted", "measured", "strong-start", "new-heights", "far-horizons", "cassandra", "lone-torch", "ascendant", "undisputed");
 /** Rarity tier a badge award reached (mirrors `Rarity` in `src/lib/badges.ts`). */
 export const RaritySchema = Schema.Literal("common", "rare", "legendary", "exotic");
 /** Per-badge counts + best rarity across a player's runs (mirrors `BadgeTally`). */
@@ -176,7 +176,8 @@ const SoloRunReviewEntrySchema = Schema.Struct({
     questionId: Schema.NullOr(Schema.String),
     mediaUrl: Schema.NullOr(Schema.String),
     mediaType: Schema.NullOr(MediaTypeSchema),
-    source: Schema.NullOr(QuestionSourceSchema),
+    // Null first: the stored-source transform accepts any value, null included.
+    source: Schema.Union(Schema.Null, StoredQuestionSourceSchema),
     postAnswerNote: Schema.NullOr(Schema.String),
 });
 /** Body of `GET /api/pages/history/solo/:id`. */

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

@@ -132,10 +132,13 @@ export declare const QuizResultsPageSchema: Schema.Struct<{
         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>>;
-        }>>;
+        source: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+            readonly url: string;
+            readonly label?: string | undefined;
+        }, {
+            readonly url: string;
+            readonly label?: string | undefined;
+        }, never>>>>;
         postAnswerNote: Schema.optional<typeof Schema.String>;
     }>>>>;
     canFlag: typeof Schema.Boolean;

package/dist/question.schema.d.ts

@@ -14,6 +14,18 @@ export declare const QuestionSourceSchema: Schema.Struct<{
     url: Schema.filter<Schema.filter<typeof Schema.String>>;
     label: Schema.optional<Schema.filter<typeof Schema.String>>;
 }>;
+/**
+ * Read-side source: any stored value that fails `QuestionSourceSchema`
+ * (bad url, bad label, wrong shape) decodes to undefined, so one bad source
+ * never fails a whole page.
+ */
+export declare const StoredQuestionSourceSchema: Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+    readonly url: string;
+    readonly label?: string | undefined;
+}, {
+    readonly url: string;
+    readonly label?: string | undefined;
+}, never>>>;
 export declare const PostAnswerNoteSchema: Schema.filter<typeof Schema.String>;
 declare const TextChoiceSchema: Schema.Struct<{
     type: Schema.Literal<["text_choice"]>;

package/dist/question.schema.js

@@ -30,6 +30,17 @@ export const QuestionSourceSchema = Schema.Struct({
         message: () => "Source label must be 200 characters or fewer",
     }))),
 });
+const isQuestionSource = Schema.is(QuestionSourceSchema);
+/**
+ * Read-side source: any stored value that fails `QuestionSourceSchema`
+ * (bad url, bad label, wrong shape) decodes to undefined, so one bad source
+ * never fails a whole page.
+ */
+export const StoredQuestionSourceSchema = Schema.transform(Schema.Unknown, Schema.UndefinedOr(Schema.typeSchema(QuestionSourceSchema)), {
+    strict: true,
+    decode: (source) => (isQuestionSource(source) ? source : undefined),
+    encode: (source) => source,
+});
 export const PostAnswerNoteSchema = Schema.String.pipe(Schema.maxLength(160, {
     message: () => "Post-answer note must be 160 characters or fewer",
 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orakl/protocol",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Orakl wire contract: WebSocket frames and API response schemas.",
   "license": "AGPL-3.0-only",
   "repository": {