@orakl/protocol 0.12.0 → 0.13.0

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

@@ -623,12 +623,7 @@ export declare const CuratorHistoryEntryPageSchema: Schema.Struct<{
             readonly questionText?: string | undefined;
             readonly mediaUrl?: string | undefined;
             readonly mediaType?: "audio" | "video" | "image" | undefined;
-            readonly mediaCredit?: {
-                readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
-                readonly author?: string | undefined;
-                readonly sourceUrl?: string | undefined;
-                readonly licenceUrl?: string | undefined;
-            } | undefined;
+            readonly mediaCredit?: unknown;
         }, never>>>>;
     }>;
     presetLimit: typeof Schema.Number;

package/dist/pages/app.schema.js

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

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

@@ -19,12 +19,17 @@ 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"]>>;
-    mediaCredit: Schema.optional<Schema.filter<Schema.Struct<{
-        licence: Schema.Literal<["cc0", "public-domain", "cc-by", "cc-by-sa", "own"]>;
-        author: Schema.optional<Schema.filter<typeof Schema.String>>;
-        sourceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-        licenceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-    }>>>;
+    mediaCredit: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+        readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+        readonly author?: string | undefined;
+        readonly sourceUrl?: string | undefined;
+        readonly licenceUrl?: string | undefined;
+    }, {
+        readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+        readonly author?: string | undefined;
+        readonly sourceUrl?: string | undefined;
+        readonly licenceUrl?: string | undefined;
+    }, never>>>>;
     source: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
         readonly url: string;
         readonly label?: string | undefined;

package/dist/pages/common.schema.js

@@ -1,5 +1,5 @@
 import { Schema } from "effect";
-import { MediaCreditSchema, MediaTypeSchema, StoredQuestionSourceSchema, } from "../question.schema.js";
+import { MediaTypeSchema, StoredMediaCreditSchema, 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),
-    mediaCredit: Schema.optional(MediaCreditSchema),
+    mediaCredit: Schema.optional(StoredMediaCreditSchema),
     source: Schema.optional(StoredQuestionSourceSchema),
     postAnswerNote: Schema.optional(Schema.String),
 });

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

@@ -241,12 +241,17 @@ 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"]>>;
-        mediaCredit: Schema.optional<Schema.filter<Schema.Struct<{
-            licence: Schema.Literal<["cc0", "public-domain", "cc-by", "cc-by-sa", "own"]>;
-            author: Schema.optional<Schema.filter<typeof Schema.String>>;
-            sourceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-            licenceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-        }>>>;
+        mediaCredit: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+            readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+            readonly author?: string | undefined;
+            readonly sourceUrl?: string | undefined;
+            readonly licenceUrl?: string | undefined;
+        }, {
+            readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+            readonly author?: string | undefined;
+            readonly sourceUrl?: string | undefined;
+            readonly licenceUrl?: string | undefined;
+        }, never>>>>;
         source: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
             readonly url: string;
             readonly label?: string | undefined;
@@ -302,12 +307,17 @@ 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"]>>;
-        mediaCredit: Schema.optional<Schema.NullOr<Schema.filter<Schema.Struct<{
-            licence: Schema.Literal<["cc0", "public-domain", "cc-by", "cc-by-sa", "own"]>;
-            author: Schema.optional<Schema.filter<typeof Schema.String>>;
-            sourceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-            licenceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-        }>>>>;
+        mediaCredit: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+            readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+            readonly author?: string | undefined;
+            readonly sourceUrl?: string | undefined;
+            readonly licenceUrl?: string | undefined;
+        }, {
+            readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+            readonly author?: string | undefined;
+            readonly sourceUrl?: string | undefined;
+            readonly licenceUrl?: string | undefined;
+        }, never>>>]>>;
         source: Schema.Union<[typeof Schema.Null, Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
             readonly url: string;
             readonly label?: string | undefined;

package/dist/pages/history.schema.js

@@ -1,5 +1,5 @@
 import { Schema } from "effect";
-import { MediaCreditSchema, MediaTypeSchema, StoredQuestionSourceSchema, } from "../question.schema.js";
+import { MediaTypeSchema, StoredMediaCreditSchema, 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`). */
@@ -208,7 +208,8 @@ const SoloRunReviewEntrySchema = Schema.Struct({
     mediaUrl: Schema.NullOr(Schema.String),
     mediaType: Schema.NullOr(MediaTypeSchema),
     // Optional: a review served before credits existed has no key.
-    mediaCredit: Schema.optional(Schema.NullOr(MediaCreditSchema)),
+    // Null first: the stored-credit transform accepts any value, null included.
+    mediaCredit: Schema.optional(Schema.Union(Schema.Null, StoredMediaCreditSchema)),
     // Null first: the stored-source transform accepts any value, null included.
     source: Schema.Union(Schema.Null, StoredQuestionSourceSchema),
     postAnswerNote: Schema.NullOr(Schema.String),

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

@@ -152,12 +152,17 @@ 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"]>>;
-        mediaCredit: Schema.optional<Schema.filter<Schema.Struct<{
-            licence: Schema.Literal<["cc0", "public-domain", "cc-by", "cc-by-sa", "own"]>;
-            author: Schema.optional<Schema.filter<typeof Schema.String>>;
-            sourceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-            licenceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
-        }>>>;
+        mediaCredit: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+            readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+            readonly author?: string | undefined;
+            readonly sourceUrl?: string | undefined;
+            readonly licenceUrl?: string | undefined;
+        }, {
+            readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+            readonly author?: string | undefined;
+            readonly sourceUrl?: string | undefined;
+            readonly licenceUrl?: string | undefined;
+        }, never>>>>;
         source: Schema.optional<Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
             readonly url: string;
             readonly label?: string | undefined;

package/dist/question.schema.d.ts

@@ -24,6 +24,22 @@ export declare const MediaCreditSchema: Schema.filter<Schema.Struct<{
     licenceUrl: Schema.optional<Schema.filter<Schema.filter<typeof Schema.String>>>;
 }>>;
 export type MediaCredit = typeof MediaCreditSchema.Type;
+/**
+ * Read-side credit: a stored value that fails `MediaCreditSchema` (a rule
+ * tightened after it was written, a wrong shape) decodes to undefined, so one
+ * bad credit never fails a whole page.
+ */
+export declare const StoredMediaCreditSchema: Schema.transform<typeof Schema.Unknown, Schema.UndefinedOr<Schema.SchemaClass<{
+    readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+    readonly author?: string | undefined;
+    readonly sourceUrl?: string | undefined;
+    readonly licenceUrl?: string | undefined;
+}, {
+    readonly licence: "cc0" | "public-domain" | "cc-by" | "cc-by-sa" | "own";
+    readonly author?: string | undefined;
+    readonly sourceUrl?: string | undefined;
+    readonly licenceUrl?: string | undefined;
+}, never>>>;
 export declare const MediaSchema: Schema.Struct<{
     type: Schema.Literal<["image", "audio", "video"]>;
     url: typeof Schema.String;

package/dist/question.schema.js

@@ -57,6 +57,17 @@ export const MediaCreditSchema = Schema.Struct({
 }).pipe(Schema.filter((c) => !ATTRIBUTION_LICENCES.includes(c.licence) ||
     Boolean(c.author?.trim()) ||
     "Author is required for CC BY and CC BY-SA"));
+const isMediaCredit = Schema.is(MediaCreditSchema);
+/**
+ * Read-side credit: a stored value that fails `MediaCreditSchema` (a rule
+ * tightened after it was written, a wrong shape) decodes to undefined, so one
+ * bad credit never fails a whole page.
+ */
+export const StoredMediaCreditSchema = Schema.transform(Schema.Unknown, Schema.UndefinedOr(Schema.typeSchema(MediaCreditSchema)), {
+    strict: true,
+    decode: (credit) => (isMediaCredit(credit) ? credit : undefined),
+    encode: (credit) => credit,
+});
 export const MediaSchema = Schema.Struct({
     type: MediaTypeSchema,
     url: Schema.String,

package/package.json

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