question-bank-framework 0.1.1 → 0.2.0

package/core/types.ts

@@ -1,6 +1,7 @@
 // Core question + bank types. Framework-owned, never ejected.
-// A bank's question shape is config-defined: every question has the four
-// core fields, plus arbitrary subject-specific metadata (year, marks, …).
+// Every question has the core fields below; subjects extend the interface
+// with their own metadata (year, marks, …) and the bank stays generic over
+// it — no index signatures, no `unknown`, no casts in subject code.
 
 export const questionStatuses = ['unanswered', 'revisit', 'complete'] as const;
 
@@ -12,8 +13,7 @@ export interface BaseQuestion {
   title: string;
   prompt: string;
   tags: string[];
-  // Subject-specific fields (e.g. year, semester, marks, source).
-  [key: string]: unknown;
+  // Subjects extend this interface with their own fields; see template/bank.config.ts.
 }
 
 export interface QuizSession {
@@ -54,13 +54,19 @@ export interface BankFieldOption {
   label: string;
 }
 
-export interface BankFieldDef {
+export interface BankFieldDef<Q extends BaseQuestion = BaseQuestion> {
   /** Stable field id. Reserved: id, title, tags, status. */
   id: string;
   label: string;
   type: BankFieldType;
-  /** Extract the raw value from a question. */
-  getValue: (question: BaseQuestion) => string | number | null | readonly string[];
+  /**
+   * Extract the raw value from a question. Q is inferred from the bank's
+   * questions. Method syntax (not a function property) keeps subject field
+   * defs assignable to the stored bank with zero casts — standard
+   * bivariant-method assignability, like Map/Set methods. Sound here
+   * because fields are only ever called with their own bank's questions.
+   */
+  getValue(question: Q): string | number | null | readonly string[];
   /**
    * Fixed options for select/multiselect. When omitted, options are derived
    * from distinct values across the bank's questions (sorted).
@@ -82,13 +88,13 @@ export interface BankSiteConfig {
   description?: string;
 }
 
-export interface DefineBankInput {
+export interface DefineBankInput<Q extends BaseQuestion = BaseQuestion> {
   site: BankSiteConfig;
   /** Namespaces localStorage keys + Convex lookups. e.g. "comp20008". */
   namespace: string;
   /** Subject-specific schema. Built-ins (id/title/tags/status) are automatic. */
-  fields: BankFieldDef[];
-  questions: BaseQuestion[];
+  fields: BankFieldDef<Q>[];
+  questions: Q[];
   /** Suggested answers keyed by question id. Missing entries hide "Show answer". */
   answers?: Record<string, string>;
   /** Default sort for the grid, e.g. [{ id: "exam", desc: true }]. */
@@ -97,12 +103,17 @@ export interface DefineBankInput {
   publicPath?: string;
 }
 
-export interface Bank extends DefineBankInput {
+export interface Bank extends DefineBankInput<BaseQuestion> {
   answers: Record<string, string>;
   questionById: Map<string, BaseQuestion>;
 }
 
-export function defineBank(input: DefineBankInput): Bank {
+/**
+ * Build a bank. Q is inferred from `questions`, so each field's getValue is
+ * checked against the subject's question type — accessors use plain property
+ * access, no casts or coercion helpers.
+ */
+export function defineBank<Q extends BaseQuestion>(input: DefineBankInput<Q>): Bank {
   return {
     ...input,
     answers: input.answers ?? {},

package/framework/lib/question-filter.ts

@@ -220,7 +220,9 @@ function resolveFieldValue(
     if (ruleField === 'title') return question.title;
     if (ruleField === 'id') return question.id;
     if (ruleField === 'tags') return question.tags;
-    return (question[ruleField] as string | number | null | readonly string[]) ?? null;
+    // status is handled by matchesRule before reaching here. Any other id
+    // is stale (no def, not a built-in) — match nothing.
+    return null;
   }
   return def.getValue(question);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "question-bank-framework",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Framework-style question bank: TanStack Start + TanStack Table grid, quizzes, and filter DSL. Bring your own bank.config.ts + content/. Eject any framework/ file with `qb reveal` (Vike-style).",
   "type": "module",
   "license": "MIT",

package/template/bank.config.ts

@@ -3,26 +3,20 @@
 // config-defined — the framework never hardcodes subject fields.
 
 import { defineBank } from 'question-bank-framework';
+import type { BaseQuestion } from 'question-bank-framework';
 import questionsJson from './content/questions.json' with { type: 'json' };
 import { answers } from './content/answers.ts';
-import type { BaseQuestion } from 'question-bank-framework';
-
-const questions = questionsJson as BaseQuestion[];
 
-const str = (q: BaseQuestion, key: string): string => {
-  const v = q[key];
-  return typeof v === 'string' || typeof v === 'number' ? String(v) : '';
-};
+/** Subject question shape. Declare every field your accessors touch. */
+export interface Comp20008Question extends BaseQuestion {
+  year: number;
+  semester: string;
+  number: number;
+  marks: number | null;
+  source: string;
+}
 
-const num = (q: BaseQuestion, key: string): number | null => {
-  const v = q[key];
-  if (typeof v === 'number' && Number.isFinite(v)) return v;
-  if (typeof v === 'string' && v.trim() !== '') {
-    const n = Number(v);
-    return Number.isFinite(n) ? n : null;
-  }
-  return null;
-};
+const questions = questionsJson as Comp20008Question[];
 
 export const bank = defineBank({
   site: {
@@ -36,14 +30,14 @@ export const bank = defineBank({
       id: 'year',
       label: 'Year',
       type: 'select',
-      getValue: (q) => (typeof q['year'] === 'number' ? String(q['year']) : ''),
+      getValue: (q) => String(q.year),
       searchable: true,
     },
     {
       id: 'semester',
       label: 'Semester',
       type: 'select',
-      getValue: (q) => str(q, 'semester'),
+      getValue: (q) => q.semester,
       options: [
         { value: 'S1', label: 'Semester 1' },
         { value: 'S2', label: 'Semester 2' },
@@ -53,7 +47,7 @@ export const bank = defineBank({
       id: 'exam',
       label: 'Exam',
       type: 'text',
-      getValue: (q) => `${str(q, 'year')} ${str(q, 'semester')}`.trim(),
+      getValue: (q) => `${q.year} ${q.semester}`,
       searchable: true,
       column: { header: 'Exam', width: 108, sortable: false },
     },
@@ -61,7 +55,7 @@ export const bank = defineBank({
       id: 'marks',
       label: 'Marks',
       type: 'number',
-      getValue: (q) => num(q, 'marks'),
+      getValue: (q) => q.marks,
       placeholder: 'Value',
       column: { header: 'Marks', width: 78 },
     },