gwchq-textjam 0.5.2 → 0.5.4

package/dist/index.js

@@ -382711,9 +382711,12 @@ const WebComponentLoader = (props) => {
     (0, react_1.useEffect)(() => {
         dispatch((0, EditorSlice_1.setReadOnly)(readOnly));
     }, [readOnly, dispatch]);
+    // Depend on the mode value: the host rebuilds `curriculum` whenever its
+    // content changes, and that must not reset a student's expanded view.
+    const hostCurriculumDisplayMode = curriculum?.curriculumDisplayMode ?? types_1.CurriculumDisplayMode.HIDDEN;
     (0, react_1.useEffect)(() => {
-        dispatch((0, EditorSlice_1.setCurriculumDisplayMode)(curriculum?.curriculumDisplayMode ?? types_1.CurriculumDisplayMode.HIDDEN));
-    }, [curriculum, dispatch]);
+        dispatch((0, EditorSlice_1.setCurriculumDisplayMode)(hostCurriculumDisplayMode));
+    }, [hostCurriculumDisplayMode, dispatch]);
     (0, react_1.useEffect)(() => {
         if (isCodeVisible !== undefined) {
             dispatch((0, EditorSlice_1.setCodeVisibility)({ isVisible: isCodeVisible }));
@@ -383649,9 +383652,13 @@ const useProject = ({ projectData, projectContent = null, starterCodeContent = n
         const sourceComponents = incomingData?.components ?? defaultProject.components ?? [];
         // clone components before sorting to avoid mutating frozen/template objects
         const preparedComponents = prepareTemplateComponents(sourceComponents);
+        // incomingData is assembled by the host from partially loaded state, so
+        // it can carry undefined fields (e.g. name before the first save).
+        // dropping them keeps the default template's values as the real fallback
+        const definedIncomingData = Object.fromEntries(Object.entries(incomingData ?? {}).filter(([, value]) => value !== undefined));
         const projectToSet = {
             ...defaultProject,
-            ...incomingData,
+            ...definedIncomingData,
             components: preparedComponents,
             commitId: null,
         };
@@ -383694,8 +383701,12 @@ const useProject = ({ projectData, projectContent = null, starterCodeContent = n
             }
             return;
         }
-        // if user has chosen start new for a draft, ignore cache completely
-        if (!projectData?.commitId && shouldBypassCachedDraft) {
+        // if user has chosen start new for a draft, ignore cache completely.
+        // starter code takes precedence over the project-type template: when an
+        // archive is available useProjectStarterCode applies it instead.
+        if (!projectData?.commitId &&
+            shouldBypassCachedDraft &&
+            !starterCodeContent) {
             if (loadTemplateProjectData && !isTemplateDataLoaded) {
                 dispatch((0, EditorSlice_1.setLoading)(types_1.LoadingState.IDLE));
                 loadTemplateProjectData();
@@ -384252,11 +384263,14 @@ const useIsMounted_1 = __webpack_require__(76314);
 const useProjectCache_1 = __webpack_require__(69557);
 const useUnsavedDraftResolution_1 = __webpack_require__(61171);
 const isFinalLoadingState = (state) => state === types_1.LoadingState.SUCCESS || state === types_1.LoadingState.FAILED;
+// distinguishes "not applied yet" from a project whose cache key is undefined
+const NOT_APPLIED = Symbol("starterCodeNotApplied");
 // unpacks a starter-code zip archive and applies it as the initial project
 const useProjectStarterCode = ({ projectData, starterCodeContent = null, isLoading = false, isPreviewMode = false, }) => {
     const dispatch = (0, react_redux_1.useDispatch)();
     const isMounted = (0, useIsMounted_1.useIsMounted)();
     const callIdRef = (0, react_1.useRef)(null);
+    const appliedForCacheKeyRef = (0, react_1.useRef)(NOT_APPLIED);
     const loadingState = (0, stores_1.useAppSelector)((state) => state.editor.loading);
     const savingState = (0, stores_1.useAppSelector)((state) => state.editor.saving);
     const commitIdLoadTriggered = (0, stores_1.useAppSelector)((state) => state.editor.commitIdLoadTriggered);
@@ -384272,26 +384286,33 @@ const useProjectStarterCode = ({ projectData, starterCodeContent = null, isLoadi
         isCurrentOutdated,
     });
     (0, react_1.useEffect)(() => {
+        // nothing to unpack, or nowhere to unpack it into
         if (!starterCodeContent || !projectData)
             return;
-        if (isLoading || isLoadingCache)
-            return;
-        if (!isCacheLoaded && cacheKey)
-            return;
-        if (commitIdLoadTriggered)
-            return;
-        if (projectData.commitId)
-            return;
-        if (cachedProject)
-            return;
-        if (isPreviewMode)
-            return;
-        if (saveTriggered || savingState === types_1.SavingState.PROCESS)
-            return;
-        if (isFinalLoadingState(loadingState) && !shouldBypassCachedDraft)
+        // inputs are still settling
+        const isCachePending = isLoading || isLoadingCache || (!isCacheLoaded && !!cacheKey);
+        // another source of project content already owns this load
+        const hasConflictingOperation = !!commitIdLoadTriggered ||
+            !!projectData.commitId ||
+            isPreviewMode ||
+            saveTriggered ||
+            savingState === types_1.SavingState.PROCESS;
+        // a cached draft, or a project that already finished loading, must not be
+        // overwritten - unless the student chose "Start new"
+        const shouldPreserveExistingProject = (!!cachedProject || isFinalLoadingState(loadingState)) &&
+            !shouldBypassCachedDraft;
+        // the bypass flag stays set until the first save, and the fresh project
+        // reaches the cache moments later: without this guard the archive would be
+        // re-applied on top of the student's first edits
+        const isAlreadyApplied = appliedForCacheKeyRef.current === cacheKey;
+        if (isCachePending ||
+            hasConflictingOperation ||
+            shouldPreserveExistingProject ||
+            isAlreadyApplied)
             return;
         const callId = Symbol("loadStarterCodeFromZip");
         callIdRef.current = callId;
+        appliedForCacheKeyRef.current = cacheKey;
         (0, loadProjectFromZip_1.loadProjectFromZip)({
             zipBlob: starterCodeContent,
             identifier: projectData.identifier,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gwchq-textjam",
   "description": "Embeddable React editor used in Raspberry Pi text-based projects.",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "license": "Apache-2.0",
   "homepage": "https://github.com/GirlsFirst/gwchq-textjam",
   "author": "Girls Who Code HQ",