fix!: adapt to upstream features: data shape change

site.config.dev.tsx

@@ -1,6 +1,6 @@
 import { EnvironmentTypes, SiteConfig, footerApp, headerApp, shellApp } from '@openedx/frontend-base';
 
-import { instructApp } from './src';
+import { instructorDashboardApp } from './src';
 
 import './src/app.scss';
 
@@ -17,7 +17,7 @@ const siteConfig: SiteConfig = {
     shellApp,
     headerApp,
     footerApp,
-    instructApp
+    instructorDashboardApp
   ],
   externalRoutes: [
     {

site.config.test.tsx

@@ -11,7 +11,7 @@ const siteConfig: SiteConfig = {
   // if EnvironmentTypes.TEST is set, some tests fails due to it, TODO: update here once this issue is fixed in frontend-base
   environment: EnvironmentTypes?.TEST ?? 'test',
   apps: [{
-    appId: 'org.openedx.frontend.app.instructor',
+    appId: 'org.openedx.frontend.app.instructorDashboard',
     config: {}
   }],
 };

src/app.ts

@@ -3,21 +3,18 @@ import { appId } from '@src/constants';
 import routes from '@src/routes';
 import slots from '@src/slots';
 import providers from '@src/providers';
+import provides from '@src/provides';
 
 const app: App = {
   appId,
   routes,
   providers,
+  provides,
   slots,
   config: {
     NODE_ENV: 'development',
     LMS_BASE_URL: 'http://local.openedx.io:8000'
   },
-  provides: {
-    'org.openedx.frontend.provides.courseNavigationRoles.v1': {
-      courseNavigationRoles: ['org.openedx.frontend.role.instructor'],
-    },
-  },
 };
 
 export default app;

src/constants.ts

@@ -1 +1,2 @@
-export const appId = 'org.openedx.frontend.app.instructor';
+export const appId = 'org.openedx.frontend.app.instructorDashboard';
+export const instructorDashboardRole = 'org.openedx.frontend.role.instructorDashboard';

src/data/api.test.ts

@@ -35,7 +35,7 @@ describe('base api', () => {
     it('fetches course info successfully', async () => {
       const courseId = 'test-course-123';
       const result = await getCourseInfo(courseId);
-      expect(mockGetAppConfig).toHaveBeenCalledWith('org.openedx.frontend.app.instructor');
+      expect(mockGetAppConfig).toHaveBeenCalledWith('org.openedx.frontend.app.instructorDashboard');
       expect(mockGetAuthenticatedHttpClient).toHaveBeenCalled();
       expect(mockHttpClient.get).toHaveBeenCalledWith('https://test-lms.com/api/instructor/v2/courses/test-course-123');
       expect(mockCamelCaseObject).toHaveBeenCalledWith(mockCourseData);

src/dataDownloads/data/apiHook.test.tsx

@@ -30,8 +30,8 @@ describe('dataDownloads apiHook', () => {
 
   describe('queryKeys', () => {
     it('should generate correct query keys', () => {
-      expect(queryKeys.generatedReports('course-123')).toEqual(['org.openedx.frontend.app.instructor', 'dataDownloads', 'generatedReports', 'course-123']);
-      expect(queryKeys.generateReportLink('course-456')).toEqual(['org.openedx.frontend.app.instructor', 'dataDownloads', 'reportLink', 'course-456']);
+      expect(queryKeys.generatedReports('course-123')).toEqual(['org.openedx.frontend.app.instructorDashboard', 'dataDownloads', 'generatedReports', 'course-123']);
+      expect(queryKeys.generateReportLink('course-456')).toEqual(['org.openedx.frontend.app.instructorDashboard', 'dataDownloads', 'reportLink', 'course-456']);
     });
   });
 

src/index.ts

@@ -1,3 +1,2 @@
-export { default as instructApp } from './app';
-export { default as instructRoutes } from './routes';
-export { default as instructMessages } from './i18n';
+export { default as instructorDashboardApp } from './app';
+export { default as instructorDashboardRoutes } from './routes';

src/instructorNav/InstructorNav.tsx

@@ -15,7 +15,7 @@ export interface TabProps {
 const InstructorNav = () => {
   const { courseId = '', tabId = '' } = useParams<{ courseId: string, tabId?: string }>();
   const { data: courseInfo, isLoading } = useCourseInfo(courseId);
-  const widgetPropsArray = useWidgetProps('org.openedx.frontend.slot.instructor.tabs.v1') as TabProps[];
+  const widgetPropsArray = useWidgetProps('org.openedx.frontend.slot.instructorDashboard.tabs.v1') as TabProps[];
   const { clearAlerts } = useAlert();
 
   const sortedTabs = useMemo(() => {

src/provides.ts

@@ -0,0 +1,8 @@
+import { providesCourseNavigationRolesId } from '@openedx/frontend-base';
+import { instructorDashboardRole } from './constants';
+
+const provides = {
+  [providesCourseNavigationRolesId]: instructorDashboardRole
+};
+
+export default provides;

src/routes.tsx

@@ -11,6 +11,7 @@ import OpenResponsesPage from '@src/openResponses/OpenResponsesPage';
 import SpecialExamsPage from '@src/specialExams/SpecialExamsPage';
 import PageNotFound from '@src/components/PageNotFound';
 import { useWidgetProps } from './slots/SlotUtils';
+import { instructorDashboardRole } from './constants';
 
 interface InstructorRouteProps {
   tabId: string,
@@ -32,7 +33,7 @@ const defaultTabs: InstructorRouteProps[] = [
 
 const TabContent = () => {
   const { tabId } = useParams<{ tabId: string }>();
-  const routeWidgets = useWidgetProps('org.openedx.frontend.slot.instructor.routes.v1') as InstructorRouteProps[];
+  const routeWidgets = useWidgetProps('org.openedx.frontend.slot.instructorDashboard.routes.v1') as InstructorRouteProps[];
 
   const tabRoutes = [
     ...defaultTabs.filter(
@@ -48,10 +49,10 @@ const TabContent = () => {
 
 const routes = [
   {
-    id: 'org.openedx.frontend.route.instructor.main',
+    id: 'org.openedx.frontend.route.instructorDashboard.main',
     path: 'instructor-dashboard/:courseId',
     handle: {
-      role: 'org.openedx.frontend.role.instructor'
+      role: instructorDashboardRole
     },
     async lazy() {
       const module = await import('./Main');

src/slots/README.md

@@ -29,7 +29,7 @@ import { WidgetOperationTypes } from '@openedx/frontend-base';
 import { PlaceholderSlot } from './src/slots/PlaceholderSlot/PlaceholderSlot';
 import { EnvironmentTypes, SiteConfig, footerApp, headerApp, shellApp } from '@openedx/frontend-base';
 
-import { instructApp } from './src';
+import { instructorDashboardApp } from './src';
 
 import './src/app.scss';
 
@@ -47,17 +47,17 @@ const siteConfig: SiteConfig = {
     headerApp,
     footerApp,
     {
-      ...instructApp,
+      ...instructorDashboardApp,
       slots: [
         {
-          slotId: 'org.openedx.frontend.slot.instructor.tabs.v1',
-          id: 'org.openedx.frontend.widget.instructor.tab.my_tab',
+          slotId: 'org.openedx.frontend.slot.instructorDashboard.tabs.v1',
+          id: 'org.openedx.frontend.widget.instructorDashboard.tab.my_tab',
           op: WidgetOperationTypes.APPEND,
           element: <PlaceholderSlot tabId="my_tab" title="New Tab" url="my_tab" sortOrder={25} />,
         },
         {
-          slotId: 'org.openedx.frontend.slot.instructor.routes.v1',
-          id: 'org.openedx.frontend.widget.instructor.route.my_tab',
+          slotId: 'org.openedx.frontend.slot.instructorDashboard.routes.v1',
+          id: 'org.openedx.frontend.widget.instructorDashboard.route.my_tab',
           op: WidgetOperationTypes.APPEND,
           element: <PlaceholderSlot tabId="my_tab" content={<div>Dynamic Content</div>} />,
         }
@@ -108,7 +108,7 @@ export const PlaceholderSlot = (_props: Record<string, any>) => null;
 ```tsx
 const TabContent = () => {
   const { tabId } = useParams<{ tabId: string }>();
-  const routeWidgets = useWidgetProps('org.openedx.frontend.slot.instructor.routes.v1') as InstructorRouteProps[];
+  const routeWidgets = useWidgetProps('org.openedx.frontend.slot.instructorDashboard.routes.v1') as InstructorRouteProps[];
 
   const tabRoutes = [
     ...defaultTabs.filter(