refactor: Nits on the code & move utils to key-utils

Author: ChrisChV

src/generic/key-utils.test.ts

@@ -4,6 +4,8 @@ import {
   getLibraryId,
   isLibraryKey,
   isLibraryV1Key,
+  getContainerTypeFromId,
+  ContainerType,
 } from './key-utils';
 
 describe('component utils', () => {
@@ -97,4 +99,16 @@ describe('component utils', () => {
       });
     }
   });
+
+  describe('getContainerTypeFromId', () => {
+    for (const [input, expected] of [
+      ['lct:org:lib:unit:my-unit-9284e2', ContainerType.Unit],
+      ['lct:OpenCraftX:ALPHA:my-unit-a3223f', undefined],
+      ['', undefined],
+    ]) {
+      it(`returns '${expected}' for container key '${input}'`, () => {
+        expect(getContainerTypeFromId(input!)).toStrictEqual(expected);
+      });
+    }
+  });
 });

src/generic/key-utils.ts

@@ -49,3 +49,26 @@ export const buildCollectionUsageKey = (learningContextKey: string, collectionId
   const orgLib = learningContextKey.replace('lib:', '');
   return `lib-collection:${orgLib}:${collectionId}`;
 };
+
+export enum ContainerType {
+  Unit = 'unit',
+}
+
+/**
+ * Given a container key like `ltc:org:lib:unit:id`
+ * get the container type
+ */
+export function getContainerTypeFromId(containerId: string): ContainerType | undefined {
+  const parts = containerId.split(':');
+  if (parts.length < 2) {
+    return undefined;
+  }
+
+  const maybeType = parts[parts.length - 2];
+
+  if (Object.values(ContainerType).includes(maybeType as ContainerType)) {
+    return maybeType as ContainerType;
+  }
+
+  return undefined;
+}

src/library-authoring/add-content/AddContent.tsx

@@ -31,7 +31,7 @@ import { blockTypes } from '../../editors/data/constants/app';
 
 import messages from './messages';
 import type { BlockTypeMetadata } from '../data/api';
-import { getContainerTypeFromId, ContainerType } from '../utils';
+import { getContainerTypeFromId, ContainerType } from '../../generic/key-utils';
 
 type ContentType = {
   name: string,
@@ -208,7 +208,7 @@ const AddContent = () => {
     unitId,
   } = useLibraryContext();
   const addComponentsToCollectionMutation = useAddComponentsToCollection(libraryId, collectionId);
-  const addComponentsToContainerMutation = useAddComponentsToContainer(unitId);
+  const addComponentsToContainerMutation = useAddComponentsToContainer(libraryId, unitId);
   const createBlockMutation = useCreateLibraryBlock();
   const pasteClipboardMutation = useLibraryPasteClipboard();
   const { showToast } = useContext(ToastContext);

src/library-authoring/create-unit/CreateUnitModal.tsx

@@ -13,7 +13,7 @@ import messages from './messages';
 import { useCreateLibraryContainer } from '../data/apiHooks';
 import { ToastContext } from '../../generic/toast-context';
 import LoadingButton from '../../generic/loading-button';
-import { ContainerType } from '../utils';
+import { ContainerType } from '../../generic/key-utils';
 
 const CreateUnitModal = () => {
   const intl = useIntl();

src/library-authoring/data/api.ts

@@ -1,7 +1,7 @@
 import { camelCaseObject, getConfig, snakeCaseObject } from '@edx/frontend-platform';
 import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
 import { VersionSpec } from '../LibraryBlock';
-import { type ContainerType } from '../utils';
+import { type ContainerType } from '../../generic/key-utils';
 
 const getApiBaseUrl = () => getConfig().STUDIO_BASE_URL;
 

src/library-authoring/data/apiHooks.ts

@@ -672,9 +672,9 @@ export const useContainerChildren = (libraryId?: string, containerId?: string) =
 );
 
 /**
- * Use this mutatio to add components to a container
+ * Use this mutation to add components to a container
  */
-export const useAddComponentsToContainer = (containerId?: string) => {
+export const useAddComponentsToContainer = (libraryId?: string, containerId?: string) => {
   const queryClient = useQueryClient();
   return useMutation({
     mutationFn: async (componentIds: string[]) => {
@@ -684,7 +684,7 @@ export const useAddComponentsToContainer = (containerId?: string) => {
       return undefined;
     },
     onSettled: () => {
-      queryClient.invalidateQueries({ queryKey: containerQueryKeys.children(containerId) });
+      queryClient.invalidateQueries({ queryKey: libraryAuthoringQueryKeys.containerChildren(libraryId, containerId) });
     },
   });
 };