@duckpic/content-spec 0.2.10 → 0.2.11

package/dist/components/VocabularyList.d.ts

@@ -3,6 +3,15 @@ import type { ComponentSpec } from "./ComponentSpec";
 export declare const VocabularyListPropsSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     staticVocabIds: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+    staticVocabItems: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        kind: z.ZodOptional<z.ZodEnum<{
+            vocabulary: "vocabulary";
+            alternative: "alternative";
+        }>>;
+        vocabularyId: z.ZodOptional<z.ZodNumber>;
+        alternativeVocabularyId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>>;
     userActions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
         select: "select";
         "blur-select": "blur-select";

package/dist/components/VocabularyList.js

@@ -1,8 +1,10 @@
 import { z } from "zod";
 import { VisibleForLevelsSchema } from "../schema/Level";
+import { VocabularyIdArraySchema, VocabularyItemRefArraySchema, VocabularyRuntimeSelectionSchema, VocabularyListStoredItemSchema, } from "../schema/Vocabulary";
 export const VocabularyListPropsSchema = z.object({
     title: z.string().optional(),
-    staticVocabIds: z.array(z.number()).default([]),
+    staticVocabIds: VocabularyIdArraySchema.default([]),
+    staticVocabItems: z.array(VocabularyListStoredItemSchema).optional(),
     userActions: z.array(z.enum(["select", "blur-select", "add-to-my-vocabulary"])).default([]),
     visibleForLevels: VisibleForLevelsSchema,
 });
@@ -13,16 +15,21 @@ export const VocabularyListComponentSpec = {
     io: {
         inputs: {
             extraVocabIds: {
-                schema: z.array(z.number()),
-                valueType: "VocabId[]",
-                description: "Additional vocab ids injected at runtime (e.g. incorrect answers)."
+                schema: VocabularyRuntimeSelectionSchema,
+                valueType: "VocabId[] | VocabItemRef[]",
+                description: "Additional vocabulary ids or refs injected at runtime."
             }
         },
         outputs: {
             selectedVocabIds: {
-                schema: z.array(z.number()),
+                schema: VocabularyIdArraySchema,
                 valueType: "VocabId[]",
-                description: "Ids the student marked or selected in this list."
+                description: "Primary vocabulary ids the student marked or selected in this list."
+            },
+            selectedVocabRefs: {
+                schema: VocabularyItemRefArraySchema,
+                valueType: "VocabItemRef[]",
+                description: "Exact vocabulary items the student marked or selected in this list."
             }
         }
     },

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export * from "./components/VocabularyList";
 export * from "./components/SubmitButton";
 export * from "./schema/PageTree";
 export * from "./schema/Level";
+export * from "./schema/Vocabulary";
 import type { ComponentSpec } from "./components/ComponentSpec.ts";
 export declare const ComponentRegistry: {
     Text: ComponentSpec;

package/dist/index.js

@@ -8,6 +8,7 @@ export * from "./components/VocabularyList";
 export * from "./components/SubmitButton";
 export * from "./schema/PageTree";
 export * from "./schema/Level";
+export * from "./schema/Vocabulary";
 import { TextComponentSpec } from "./components/Text";
 import { QuizComponentSpec } from "./components/Quiz";
 import { LayoutComponentSpec } from "./components/Layout";

package/dist/schema/Vocabulary.d.ts

@@ -0,0 +1,45 @@
+import { z } from "zod";
+export declare const VocabularyItemKindSchema: z.ZodEnum<{
+    vocabulary: "vocabulary";
+    alternative: "alternative";
+}>;
+export declare const VocabularyItemRefSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    kind: z.ZodOptional<z.ZodEnum<{
+        vocabulary: "vocabulary";
+        alternative: "alternative";
+    }>>;
+    vocabularyId: z.ZodOptional<z.ZodNumber>;
+    alternativeVocabularyId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const VocabularyListStoredItemSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    kind: z.ZodOptional<z.ZodEnum<{
+        vocabulary: "vocabulary";
+        alternative: "alternative";
+    }>>;
+    vocabularyId: z.ZodOptional<z.ZodNumber>;
+    alternativeVocabularyId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+export declare const VocabularyItemRefArraySchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    kind: z.ZodOptional<z.ZodEnum<{
+        vocabulary: "vocabulary";
+        alternative: "alternative";
+    }>>;
+    vocabularyId: z.ZodOptional<z.ZodNumber>;
+    alternativeVocabularyId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;
+export declare const VocabularyIdArraySchema: z.ZodArray<z.ZodNumber>;
+export declare const VocabularyRuntimeSelectionSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodNumber>, z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    kind: z.ZodOptional<z.ZodEnum<{
+        vocabulary: "vocabulary";
+        alternative: "alternative";
+    }>>;
+    vocabularyId: z.ZodOptional<z.ZodNumber>;
+    alternativeVocabularyId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>]>;
+export type VocabularyItemKind = z.infer<typeof VocabularyItemKindSchema>;
+export type VocabularyItemRef = z.infer<typeof VocabularyItemRefSchema>;
+export type VocabularyListStoredItem = z.infer<typeof VocabularyListStoredItemSchema>;

package/dist/schema/Vocabulary.js

@@ -0,0 +1,17 @@
+import { z } from "zod";
+export const VocabularyItemKindSchema = z.enum(["vocabulary", "alternative"]);
+export const VocabularyItemRefSchema = z.object({
+    id: z.number(),
+    kind: VocabularyItemKindSchema.optional(),
+    vocabularyId: z.number().optional(),
+    alternativeVocabularyId: z.number().optional(),
+});
+// Stored vocabulary items may be plain refs or hydrated item payloads.
+// Keep this permissive so editor/runtime data survives validation.
+export const VocabularyListStoredItemSchema = VocabularyItemRefSchema.passthrough();
+export const VocabularyItemRefArraySchema = z.array(VocabularyItemRefSchema);
+export const VocabularyIdArraySchema = z.array(z.number());
+export const VocabularyRuntimeSelectionSchema = z.union([
+    VocabularyIdArraySchema,
+    VocabularyItemRefArraySchema,
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duckpic/content-spec",
-  "version": "0.2.10",
+  "version": "0.2.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/src/components/VocabularyList.ts

@@ -1,10 +1,17 @@
 import { z } from "zod";
 import type { ComponentSpec } from "./ComponentSpec";
 import { VisibleForLevelsSchema } from "../schema/Level";
+import {
+  VocabularyIdArraySchema,
+  VocabularyItemRefArraySchema,
+  VocabularyRuntimeSelectionSchema,
+  VocabularyListStoredItemSchema,
+} from "../schema/Vocabulary";
 
 export const VocabularyListPropsSchema = z.object({
   title: z.string().optional(),
-  staticVocabIds: z.array(z.number()).default([]),
+  staticVocabIds: VocabularyIdArraySchema.default([]),
+  staticVocabItems: z.array(VocabularyListStoredItemSchema).optional(),
   userActions: z.array(z.enum(["select", "blur-select", "add-to-my-vocabulary"])).default([]),
   visibleForLevels: VisibleForLevelsSchema,
 });
@@ -16,16 +23,21 @@ export const VocabularyListComponentSpec: ComponentSpec = {
   io: {
     inputs: {
       extraVocabIds: {
-        schema: z.array(z.number()),
-        valueType: "VocabId[]",
-        description: "Additional vocab ids injected at runtime (e.g. incorrect answers)."
+        schema: VocabularyRuntimeSelectionSchema,
+        valueType: "VocabId[] | VocabItemRef[]",
+        description: "Additional vocabulary ids or refs injected at runtime."
       }
     },
     outputs: {
       selectedVocabIds: {
-        schema: z.array(z.number()),
+        schema: VocabularyIdArraySchema,
         valueType: "VocabId[]",
-        description: "Ids the student marked or selected in this list."
+        description: "Primary vocabulary ids the student marked or selected in this list."
+      },
+      selectedVocabRefs: {
+        schema: VocabularyItemRefArraySchema,
+        valueType: "VocabItemRef[]",
+        description: "Exact vocabulary items the student marked or selected in this list."
       }
     }
   },

package/src/index.ts

@@ -8,6 +8,7 @@ export * from "./components/VocabularyList";
 export * from "./components/SubmitButton";
 export * from "./schema/PageTree";
 export * from "./schema/Level";
+export * from "./schema/Vocabulary";
 
 
 import { TextComponentSpec } from "./components/Text";

package/src/schema/Vocabulary.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+
+export const VocabularyItemKindSchema = z.enum(["vocabulary", "alternative"]);
+
+export const VocabularyItemRefSchema = z.object({
+  id: z.number(),
+  kind: VocabularyItemKindSchema.optional(),
+  vocabularyId: z.number().optional(),
+  alternativeVocabularyId: z.number().optional(),
+});
+
+// Stored vocabulary items may be plain refs or hydrated item payloads.
+// Keep this permissive so editor/runtime data survives validation.
+export const VocabularyListStoredItemSchema = VocabularyItemRefSchema.passthrough();
+
+export const VocabularyItemRefArraySchema = z.array(VocabularyItemRefSchema);
+export const VocabularyIdArraySchema = z.array(z.number());
+export const VocabularyRuntimeSelectionSchema = z.union([
+  VocabularyIdArraySchema,
+  VocabularyItemRefArraySchema,
+]);
+
+export type VocabularyItemKind = z.infer<typeof VocabularyItemKindSchema>;
+export type VocabularyItemRef = z.infer<typeof VocabularyItemRefSchema>;
+export type VocabularyListStoredItem = z.infer<typeof VocabularyListStoredItemSchema>;