@doenet/assignment-viewer 0.1.0-alpha-14 → 0.1.0-alpha-15

package/dist/index.d.ts

@@ -0,0 +1,103 @@
+import { JSX } from 'react/jsx-runtime';
+
+/** The source for creating an activity */
+export declare type ActivitySource = SingleDocSource | SelectSource | SequenceSource;
+
+export declare function ActivityViewer({ source, flags: specifiedFlags, activityId, userId, requestedVariantIndex, maxAttemptsAllowed, itemLevelAttempts, activityLevelAttempts, paginate, showFinishButton, forceDisable, forceShowCorrectness, forceShowSolution, forceUnsuppressCheckwork, addVirtualKeyboard, externalVirtualKeyboardProvided, doenetViewerUrl, fetchExternalDoenetML, darkMode, showAnswerResponseMenu, answerResponseCountsByItem, includeVariantSelector: _includeVariantSelector, showTitle, itemWord, }: {
+    source: ActivitySource;
+    flags?: DoenetMLFlagsSubset;
+    activityId?: string;
+    userId?: string | null;
+    requestedVariantIndex?: number;
+    maxAttemptsAllowed?: number;
+    itemLevelAttempts?: boolean;
+    activityLevelAttempts?: boolean;
+    paginate?: boolean;
+    showFinishButton?: boolean;
+    forceDisable?: boolean;
+    forceShowCorrectness?: boolean;
+    forceShowSolution?: boolean;
+    forceUnsuppressCheckwork?: boolean;
+    addVirtualKeyboard?: boolean;
+    externalVirtualKeyboardProvided?: boolean;
+    doenetViewerUrl?: string;
+    fetchExternalDoenetML?: (arg: string) => Promise<string>;
+    darkMode?: "dark" | "light";
+    showAnswerResponseMenu?: boolean;
+    answerResponseCountsByItem?: Record<string, number>[];
+    includeVariantSelector?: boolean;
+    showTitle?: boolean;
+    itemWord?: string;
+}): JSX.Element | null;
+
+declare type DoenetMLFlags = {
+    showCorrectness: boolean;
+    readOnly: boolean;
+    solutionDisplayMode: string;
+    showFeedback: boolean;
+    showHints: boolean;
+    allowLoadState: boolean;
+    allowSaveState: boolean;
+    allowLocalState: boolean;
+    allowSaveSubmissions: boolean;
+    allowSaveEvents: boolean;
+    autoSubmit: boolean;
+};
+
+declare type DoenetMLFlagsSubset = Partial<DoenetMLFlags>;
+
+export declare function isActivitySource(obj: unknown): obj is ActivitySource;
+
+/** The source for creating a select activity */
+declare type SelectSource = {
+    type: "select";
+    id: string;
+    title?: string;
+    /** The child activities to select from */
+    items: ActivitySource[];
+    /** The number of child activities to select (without replacement) for each attempt */
+    numToSelect: number;
+    /**
+     * Whether or not to consider each variant of each child a separate option to select from.
+     * If `selectByVariant` is `true`, the selection is from the total set of all variants,
+     * meaning selection probabilities is weighted by the number of variants each child has,
+     * and, if `numToSelect` > 1, a child could be selected multiple times for a given attempt.
+     */
+    selectByVariant: boolean;
+};
+
+/** The source for creating a sequence activity */
+declare type SequenceSource = {
+    type: "sequence";
+    id: string;
+    title?: string;
+    /** The child activities that form the sequence. */
+    items: ActivitySource[];
+    /** If `true`, randomly permute the item order on each new attempt. */
+    shuffle: boolean;
+    /**
+     * Weights given to the credit achieved of each item
+     * when averaging them to determine the credit achieved of the sequence activity.
+     * Items missing a weight are given the weight 1.
+     */
+    creditWeights?: number[];
+};
+
+/** The source for creating a single doc activity */
+declare type SingleDocSource = {
+    type: "singleDoc";
+    id: string;
+    title?: string;
+    /**
+     * If `isDescription` is `true`, then this activity is not considered one of the scored items
+     * and its credit achieved is ignored.
+     */
+    isDescription: boolean;
+    doenetML: string;
+    /** The version of DoenetML that should be used to render this activity. */
+    version: string;
+    /** The number of variants present in `doenetML` */
+    numVariants?: number;
+};
+
+export { }

package/package.json

@@ -2,7 +2,7 @@
     "name": "@doenet/assignment-viewer",
     "private": false,
     "description": "View assignments from questions written in DoenetML",
-    "version": "0.1.0-alpha-14",
+    "version": "0.1.0-alpha-15",
     "license": "AGPL-3.0-or-later",
     "homepage": "https://github.com/Doenet/assignment-viewer#readme",
     "type": "module",
@@ -13,19 +13,22 @@
     "files": [
         "/dist"
     ],
+    "types": "./dist/index.d.ts",
     "exports": {
         ".": {
+            "types": "./dist/index.d.ts",
             "import": "./dist/index.js",
             "require": "./dist/index.js"
         },
         "./*": {
+            "types": "./dist/*.d.ts",
             "import": "./dist/*",
             "require": "./dist/*"
         }
     },
     "scripts": {
         "dev": "vite",
-        "build": "tsc -b && vite build",
+        "build": "vite build",
         "test": "vitest",
         "lint": "eslint .",
         "preview": "vite preview",