mod -> modMetadata

src/analysis/analysisVisitors/pageStateAnalysis/pageStateAnalysis.test.ts

@@ -129,7 +129,9 @@ describe("PageStateAnalysis", () => {
         },
       ]);
 
-      state.mod = { id: registryIdFactory() } as BaseFormState["mod"];
+      state.modMetadata = {
+        id: registryIdFactory(),
+      } as BaseFormState["modMetadata"];
 
       const analysis = new PageStateAnalysis();
       await analysis.run(state);

src/analysis/analysisVisitors/pageStateAnalysis/pageStateAnalysis.ts

@@ -98,7 +98,7 @@ class PageStateVisitor extends AnalysisVisitorWithResolvedBricksABC {
   }
 
   override async run(formState: ModComponentFormState): Promise<void> {
-    this.isInMod = Boolean(formState.mod);
+    this.isInMod = Boolean(formState.modMetadata);
     await super.run(formState);
   }
 }

src/analysis/analysisVisitors/varAnalysis/varAnalysis.test.ts

@@ -147,7 +147,7 @@ describe("Collecting available vars", () => {
           optionsArgs: {
             foo: "bar",
           },
-          mod: modMetadataFactory({
+          modMetadata: modMetadataFactory({
             id: validateRegistryId("test/mod"),
           }),
         },
@@ -308,7 +308,7 @@ describe("Collecting available vars", () => {
 
       const formState = formStateFactory(
         {
-          mod: modMetadataFactory({
+          modMetadata: modMetadataFactory({
             id: validateRegistryId("test/mod"),
           }),
         },
@@ -343,7 +343,7 @@ describe("Collecting available vars", () => {
             bar: "qux",
             baz: "quux",
           },
-          mod: modMetadataFactory({
+          modMetadata: modMetadataFactory({
             id: validateRegistryId("test/mod"),
           }),
         },
@@ -379,7 +379,7 @@ describe("Collecting available vars", () => {
 
       const formState = formStateFactory(
         {
-          mod: modMetadataFactory({
+          modMetadata: modMetadataFactory({
             id: validateRegistryId("test/mod"),
           }),
         },
@@ -409,7 +409,7 @@ describe("Collecting available vars", () => {
 
       const formState = formStateFactory(
         {
-          mod: modMetadataFactory({
+          modMetadata: modMetadataFactory({
             id: validateRegistryId("test/mod"),
           }),
           optionsArgs: {

src/analysis/analysisVisitors/varAnalysis/varAnalysis.ts

@@ -310,11 +310,11 @@ async function setOptionsVars(
   formState: ModComponentFormState,
   contextVars: VarMap,
 ): Promise<void> {
-  if (formState.mod == null) {
+  if (formState.modMetadata == null) {
     return;
   }
 
-  const modId = formState.mod.id;
+  const modId = formState.modMetadata.id;
   const mod = await modRegistry.lookup(modId);
   const optionsSchema = mod?.options?.schema;
   if (isEmpty(optionsSchema)) {

src/components/fields/schemaFields/integrations/integrationDependencyFieldUtils.test.ts

@@ -210,7 +210,7 @@ describe("selectVariables", () => {
       permissions: emptyPermissionsFactory(),
       optionsArgs: {},
       type: "actionPanel",
-      mod: null,
+      modMetadata: null,
       modComponent: {
         blockPipeline: [
           {

src/components/fields/schemaFields/widgets/varPopup/VarMenu.tsx

@@ -175,7 +175,7 @@ const VarMenu: React.FunctionComponent<VarMenuProps> = ({
       getPageState(inspectedTab, {
         namespace: StateNamespaces.MOD,
         modComponentId: null,
-        modId: activeModComponentFormState.mod?.id,
+        modId: activeModComponentFormState.modMetadata?.id,
       }),
     [],
   );

src/pageEditor/analysisManager.ts

@@ -61,17 +61,17 @@ async function selectActiveModFormStates(
 ): Promise<ModComponentFormState[]> {
   const activeModComponentFormState = selectActiveModComponentFormState(state);
 
-  if (activeModComponentFormState?.mod) {
+  if (activeModComponentFormState?.modMetadata) {
     const dirtyModComponentFormStates =
       state.editor.modComponentFormStates.filter(
-        (x) => x.mod?.id === activeModComponentFormState.mod.id,
+        (x) => x.modMetadata?.id === activeModComponentFormState.modMetadata.id,
       );
     const dirtyIds = new Set(dirtyModComponentFormStates.map((x) => x.uuid));
 
     const activatedModComponents = selectActivatedModComponents(state);
     const otherModComponents = activatedModComponents.filter(
       (x) =>
-        x._recipe?.id === activeModComponentFormState.mod.id &&
+        x._recipe?.id === activeModComponentFormState.modMetadata.id &&
         !dirtyIds.has(x.id),
     );
     const otherModComponentFormStates = await Promise.all(
@@ -215,7 +215,7 @@ async function varAnalysisFactory(
   const modState = await getPageState(inspectedTab, {
     namespace: StateNamespaces.MOD,
     modComponentId: activeModComponentFormState.uuid,
-    modId: activeModComponentFormState.mod?.id,
+    modId: activeModComponentFormState.modMetadata?.id,
   });
 
   return new VarAnalysis({

src/pageEditor/baseFormStateTypes.ts

@@ -156,20 +156,25 @@ export type BaseFormStateV3<
    * @since 2.0.5
    * Part of the Page Editor renaming effort
    * `extensionPoint` to `starterBrick`
-   * `extension` to `modComponent`
-   * `recipe` to `mod`
    */
-
   starterBrick: TStarterBrick;
 
+  /**
+   * @since 2.0.5
+   * Part of the Page Editor renaming effort
+   * `extension` to `modComponent`
+   */
   modComponent: TModComponent;
 
   /**
+   * @since 2.0.5
+   * Part of the Page Editor renaming effort
+   * `recipe` to `modMetadata`
    * Information about the mod used to install the mod component, or `undefined`
    * if the mod component is not part of a mod.
    * @see ModComponentBase._recipe
    */
-  mod: ModComponentBase["_recipe"] | undefined;
+  modMetadata: ModComponentBase["_recipe"] | undefined;
 };
 
 export type BaseFormState<

src/pageEditor/hooks/useBuildAndValidateMod.test.ts

@@ -180,7 +180,7 @@ describe("useBuildAndValidateMod", () => {
     });
 
     const dirtyFormState1 = formStateFactory({
-      mod: modMetadata,
+      modMetadata,
     });
 
     const { result, getReduxStore } = renderHook(

src/pageEditor/hooks/useCheckModStarterBrickInvariants.test.ts

@@ -301,7 +301,7 @@ describe("useCheckModStarterBrickInvariants", () => {
       integrationDependencies: [],
     });
     const formState = await modComponentToFormState(activatedModComponent);
-    delete formState.mod;
+    delete formState.modMetadata;
 
     const { result } = renderHook(() => useCheckModStarterBrickInvariants(), {
       setupRedux(dispatch) {

src/pageEditor/hooks/useCompareModComponentCounts.test.ts

@@ -51,7 +51,7 @@ describe("useCompareModComponentCounts", () => {
       metadata: modMetadata,
     });
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -95,7 +95,7 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const dirtyFormState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -130,10 +130,10 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const dirtyFormState1 = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
     const dirtyFormState2 = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -163,7 +163,7 @@ describe("useCompareModComponentCounts", () => {
       metadata: modMetadata,
     });
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -193,7 +193,7 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -282,7 +282,7 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -313,7 +313,7 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -344,7 +344,7 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {
@@ -375,7 +375,7 @@ describe("useCompareModComponentCounts", () => {
     });
 
     const formState = formStateFactory({
-      mod: modMetadata,
+      modMetadata: modMetadata,
     });
 
     const { result } = renderHook(() => useCompareModComponentCounts(), {

src/pageEditor/hooks/useCreateModFromModComponent.test.ts

@@ -48,7 +48,9 @@ describe("useCreateModFromModComponent", () => {
 
   it("saves with no dirty changes", async () => {
     const metadata = modMetadataFactory();
-    const menuItemFormState = menuItemFormStateFactory({ mod: metadata });
+    const menuItemFormState = menuItemFormStateFactory({
+      modMetadata: metadata,
+    });
 
     appApiMock
       .onPost("/api/bricks/")
@@ -75,7 +77,9 @@ describe("useCreateModFromModComponent", () => {
   it("does not throw an error if the mod fails the compareModComponentCounts check", async () => {
     compareModComponentCountsMock.mockReturnValue(() => false);
     const metadata = modMetadataFactory();
-    const menuItemFormState = menuItemFormStateFactory({ mod: metadata });
+    const menuItemFormState = menuItemFormStateFactory({
+      modMetadata: metadata,
+    });
 
     appApiMock
       .onPost("/api/bricks/")
@@ -95,7 +99,9 @@ describe("useCreateModFromModComponent", () => {
   it("does not throw an error if the mod fails the checkModStarterBrickInvariants check", async () => {
     checkModStarterBrickInvariantsMock.mockReturnValue(async () => false);
     const metadata = modMetadataFactory();
-    const menuItemFormState = menuItemFormStateFactory({ mod: metadata });
+    const menuItemFormState = menuItemFormStateFactory({
+      modMetadata: metadata,
+    });
 
     appApiMock
       .onPost("/api/bricks/")

src/pageEditor/hooks/useCreateModFromModComponent.ts

@@ -84,7 +84,10 @@ function useCreateModFromModComponent(
           }).unwrap();
 
           const newModComponent = produce(newModComponentFormState, (draft) => {
-            draft.mod = selectModMetadata(newModDefinition, upsertResponse);
+            draft.modMetadata = selectModMetadata(
+              newModDefinition,
+              upsertResponse,
+            );
           });
 
           dispatch(editorActions.addModComponentFormState(newModComponent));

src/pageEditor/hooks/useResetMod.ts

@@ -44,7 +44,8 @@ function useResetMod(): (modId: RegistryId) => Promise<void> {
       await Promise.all(
         modComponentFormStates
           .filter(
-            (modComponentFormState) => modComponentFormState.mod?.id === modId,
+            (modComponentFormState) =>
+              modComponentFormState.modMetadata?.id === modId,
           )
           .map(async (modComponentFormState) =>
             resetModComponent({

src/pageEditor/panes/EditorPane.tsx

@@ -58,12 +58,12 @@ const EditorPaneContent: React.VoidFunctionComponent<{
   useEffect(() => {
     const messageContext = {
       extensionId: modComponentFormState.uuid,
-      blueprintId: modComponentFormState.mod
-        ? modComponentFormState.mod.id
+      blueprintId: modComponentFormState.modMetadata
+        ? modComponentFormState.modMetadata.id
         : undefined,
     };
     dispatch(logActions.setContext(messageContext));
-  }, [modComponentFormState.uuid, modComponentFormState.mod, dispatch]);
+  }, [modComponentFormState.uuid, modComponentFormState.modMetadata, dispatch]);
 
   return (
     <IntegrationsSliceModIntegrationsContextAdapter>

src/pageEditor/sidebar/ActivatedModComponentListItem.tsx

@@ -77,7 +77,7 @@ const ActivatedModComponentListItem: React.FunctionComponent<{
   );
   const isActive = activeModComponentFormState?.uuid === modComponent.id;
   // Get the selected mod id, or the mod id of the selected mod component
-  const modId = activeModId ?? activeModComponentFormState?.mod?.id;
+  const modId = activeModId ?? activeModComponentFormState?.modMetadata?.id;
   // Set the alternate background if this item isn't active, but either its mod or another item in its mod is active
   const hasActiveModBackground =
     !isActive && modId && modComponent._recipe?.id === modId;

src/pageEditor/sidebar/DraftModComponentListItem.tsx

@@ -80,9 +80,9 @@ const DraftModComponentListItem: React.FunctionComponent<
 
   const isActive =
     activeModComponentFormState?.uuid === modComponentFormState.uuid;
-  const modId = modComponentFormState.mod?.id;
-  const isSiblingOfActiveListItem = activeModComponentFormState?.mod?.id
-    ? modId === activeModComponentFormState?.mod?.id
+  const modId = modComponentFormState.modMetadata?.id;
+  const isSiblingOfActiveListItem = activeModComponentFormState?.modMetadata?.id
+    ? modId === activeModComponentFormState?.modMetadata?.id
     : false;
   const isChildOfActiveListItem = modId === activeModId;
   const isRelativeOfActiveListItem =
@@ -125,14 +125,14 @@ const DraftModComponentListItem: React.FunctionComponent<
     });
 
   const onSave = async () => {
-    if (modComponentFormState.mod) {
-      await saveMod(modComponentFormState.mod?.id);
+    if (modComponentFormState.modMetadata) {
+      await saveMod(modComponentFormState.modMetadata?.id);
     } else {
       await saveStandaloneModComponent(modComponentFormState);
     }
   };
 
-  const isSaving = modComponentFormState.mod
+  const isSaving = modComponentFormState.modMetadata
     ? isSavingMod
     : isSavingStandaloneModComponent;
 
@@ -209,14 +209,14 @@ const DraftModComponentListItem: React.FunctionComponent<
           onReset={modComponentFormState.installed ? onReset : undefined}
           isDirty={isDirty}
           onAddToMod={
-            modComponentFormState.mod
+            modComponentFormState.modMetadata
               ? undefined
               : async () => {
                   dispatch(actions.showAddToModModal());
                 }
           }
           onRemoveFromMod={
-            modComponentFormState.mod
+            modComponentFormState.modMetadata
               ? async () => {
                   dispatch(actions.showRemoveFromModModal());
                 }

src/pageEditor/sidebar/ModListItem.tsx

@@ -76,7 +76,8 @@ const ModListItem: React.FC<ModListItemProps> = ({
   const latestModVersion = modDefinition?.metadata?.version;
 
   // Set the alternate background if a mod component in this mod is active
-  const hasModBackground = activeModComponentFormState?.mod?.id === modId;
+  const hasModBackground =
+    activeModComponentFormState?.modMetadata?.id === modId;
 
   const dirtyName = useSelector(selectDirtyMetadataForModId(modId))?.name;
   const name = dirtyName ?? savedName ?? "Loading...";