@examplary/ui 1.84.1 → 1.85.0

package/dist/components/question-types/fetch-component.d.ts

@@ -1,4 +1,8 @@
 import { ComponentType } from "react";
 export declare const loadComponentStyles: (url: string) => void;
 export declare const evalComponent: (js: string) => Promise<ComponentType>;
-export declare const fetchComponent: (url: string) => Promise<ComponentType>;
+/**
+ * Loads and evaluates the component at `url`. With a `sha256`, a component
+ * that doesn't match it (e.g. replaced after a review) is refused.
+ */
+export declare const fetchComponent: (url: string, sha256?: string) => Promise<ComponentType>;

package/dist/components/question-types/fetch-component.js

@@ -78,9 +78,15 @@ export const evalComponent = async (js) => {
     })();
     return _componentResult;
 };
-export const fetchComponent = async (url) => {
-    if (componentCache.has(url)) {
-        return componentCache.get(url);
+const sha256Of = async (text) => Array.from(new Uint8Array(await crypto.subtle.digest("SHA-256", new TextEncoder().encode(text))), (byte) => byte.toString(16).padStart(2, "0")).join("");
+/**
+ * Loads and evaluates the component at `url`. With a `sha256`, a component
+ * that doesn't match it (e.g. replaced after a review) is refused.
+ */
+export const fetchComponent = async (url, sha256) => {
+    const cacheKey = sha256 ? `${sha256}:${url}` : url;
+    if (componentCache.has(cacheKey)) {
+        return componentCache.get(cacheKey);
     }
     const js = await fetch(url).then((res) => {
         if (!res.ok) {
@@ -88,7 +94,10 @@ export const fetchComponent = async (url) => {
         }
         return res.text();
     });
+    if (sha256 && (await sha256Of(js)) !== sha256) {
+        throw new Error(`The component at ${url} doesn't match its digest`);
+    }
     const res = await evalComponent(js);
-    componentCache.set(url, res);
+    componentCache.set(cacheKey, res);
     return res;
 };

package/dist/components/question-types/format-question-type.d.ts

@@ -84,7 +84,7 @@ export declare const formatQuestionType: (type: QuestionType, i18n: i18n) => {
         "settings-area"?: string | undefined;
         results?: string | undefined;
     } | undefined;
-    functions?: Record<string, string> | undefined;
+    hooks?: Record<string, string> | undefined;
     public?: boolean | undefined;
     deprecated?: boolean | undefined;
     translations?: Record<string, string | Record<string, string>> | undefined;
@@ -118,9 +118,11 @@ export declare const formatQuestionType: (type: QuestionType, i18n: i18n) => {
             settings?: Record<string, string | number | boolean | any[] | Record<string, any>> | undefined;
         } | undefined;
     } | undefined;
-    metadata?: Record<string, string | number | boolean | null> | undefined;
+    metadata?: Record<string, import("zod").JSONType> | undefined;
     readme?: string | undefined;
+    readmeUrls?: Record<string, string> | undefined;
     previewImage?: string | undefined;
+    previewImageUrls?: Record<string, string> | undefined;
     previewData?: string | undefined;
     stylesheet?: string | undefined;
     index?: number | undefined;

package/dist/types/frontend-components.d.ts

@@ -30,7 +30,6 @@ export type FrontendBaseComponentProps = {
     t: (key: string | string[], options?: any) => string;
     api: PublicApiInstance;
     i18n: any;
-    environment: FrontendComponentEnvironment;
 };
 export type FrontendAssessmentComponent = ComponentType<FrontendBaseComponentProps & {
     question: any;
@@ -39,16 +38,19 @@ export type FrontendAssessmentComponent = ComponentType<FrontendBaseComponentPro
     reviewMode?: boolean;
     answer?: Answer;
     saveAnswer: (answer: Answer) => Promise<void>;
+    environment: FrontendComponentEnvironment;
 }>;
 export type FrontendPrintComponent = ComponentType<FrontendBaseComponentProps & {
     question: any;
     answerBoxes: boolean;
     api: OrgApiInstance;
+    environment: FrontendComponentEnvironment;
 }>;
 export type FrontendResultsComponent = ComponentType<FrontendBaseComponentProps & {
     question: any;
     answer: Answer;
     api: OrgApiInstance;
+    environment: FrontendComponentEnvironment;
 }>;
 export type FrontendQuestionSettingsAreaComponent = ComponentType<FrontendBaseComponentProps & {
     question: any;
@@ -56,5 +58,42 @@ export type FrontendQuestionSettingsAreaComponent = ComponentType<FrontendBaseCo
     api: OrgApiInstance;
     setSetting: (settingId: string, value: any) => void;
     setMultipleSettings: (newSettings: Record<string, any>) => void;
+    environment: FrontendComponentEnvironment;
+}>;
+export type FrontendSettingsFieldComponent = ComponentType<FrontendBaseComponentProps & {
+    setValue: (field: string, value: any) => void;
+    submit: () => Promise<any>;
+}>;
+type PrerequisiteComponentProps = FrontendBaseComponentProps & {
+    /** The prerequisite's settings for this exam */
+    settings: Record<string, any>;
+    /** The app's icon */
+    icon?: string;
+    /** Runs one of the prerequisite's functions on the server, returning its result */
+    callFunction: (name: string, input?: unknown) => Promise<any>;
+};
+/** Shown in the exam settings once an app's prerequisite is turned on. */
+export type FrontendPrerequisiteSettingsComponent = ComponentType<PrerequisiteComponentProps & {
+    exam: {
+        id: string;
+        published: boolean;
+        startDateTime?: string;
+        endDateTime?: string;
+    };
+}>;
+/** Shown to students while an app's prerequisite isn't met. */
+export type FrontendPrerequisitePlayerComponent = ComponentType<PrerequisiteComponentProps & {
+    exam: {
+        id: string;
+        privateUrl: string;
+    };
+    user: {
+        isAuthenticated: boolean;
+        role?: string;
+    };
+    /** Passes a value to the prerequisite's `isMet` and lets the student start */
+    setValue: (value: string) => void;
+    /** The public URL of one of the prerequisite's files */
+    fileUrl: (name: string) => string;
 }>;
 export {};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@examplary/ui",
   "description": "UI components for the Examplary testing platform.",
   "packageManager": "yarn@4.5.3",
-  "version": "1.84.1",
+  "version": "1.85.0",
   "type": "module",
   "main": "dist/index.js",
   "files": [
@@ -44,7 +44,7 @@
     "@tiptap/core": "^3.17.1",
     "@tiptap/extension-bold": "^3.11.1",
     "@tiptap/extension-collaboration": "^3.22.2",
-    "@tiptap/extension-document": "^3.11.1",
+    "@tiptap/extension-document": "^3.32.0",
     "@tiptap/extension-file-handler": "^3.11.1",
     "@tiptap/extension-highlight": "^3.19.0",
     "@tiptap/extension-image": "^3.22.5",