# Pull Request Template ## Description This PR includes an update to the Captain navigation structure. ## Route Structure ```javascript 1. captain_assistants_responses_index → /captain/:assistantId/faqs 2. captain_assistants_documents_index → /captain/:assistantId/documents 3. captain_assistants_scenarios_index → /captain/:assistantId/scenarios 4. captain_assistants_playground_index → /captain/:assistantId/playground 5. captain_assistants_inboxes_index → /captain/:assistantId/inboxes 6. captain_tools_index → /captain/tools 7. captain_assistants_settings_index → /captain/:assistantId/settings 8. captain_assistants_guardrails_index → /captain/:assistantId/settings/guardrails 9. captain_assistants_guidelines_index → /captain/:assistantId/settings/guidelines 10. captain_assistants_index → /captain/:navigationPath ``` **How it works:** 1. User clicks sidebar item → Routes to `captain_assistants_index` with `navigationPath` 2. `AssistantsIndexPage` validates route and gets last active assistant, if not redirects to assistant create page. 3. Routes to actual page: `/captain/:assistantId/:page` 4. Page loads with correct assistant context Fixes https://linear.app/chatwoot/issue/CW-5832/updating-captain-navigation ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Pranav <pranav@chatwoot.com> Co-authored-by: Sojan Jose <sojan@pepalo.com>
84 lines
2.3 KiB
JavaScript
84 lines
2.3 KiB
JavaScript
import { inject, provide } from 'vue';
|
|
import { usePolicy } from 'dashboard/composables/usePolicy';
|
|
import { useRouter } from 'vue-router';
|
|
|
|
const SidebarControl = Symbol('SidebarControl');
|
|
|
|
export function useSidebarContext() {
|
|
const context = inject(SidebarControl, null);
|
|
if (context === null) {
|
|
throw new Error(`Component is missing a parent <Sidebar /> component.`);
|
|
}
|
|
|
|
const router = useRouter();
|
|
|
|
const { shouldShow } = usePolicy();
|
|
|
|
const resolvePath = to => {
|
|
if (to) return router.resolve(to)?.path || '/';
|
|
return '/';
|
|
};
|
|
|
|
// Helper to find route definition by name without resolving
|
|
const findRouteByName = name => {
|
|
const routes = router.getRoutes();
|
|
return routes.find(route => route.name === name);
|
|
};
|
|
|
|
const resolvePermissions = to => {
|
|
if (!to) return [];
|
|
|
|
// If navigationPath param exists, get the target route definition
|
|
if (to.params?.navigationPath) {
|
|
const targetRoute = findRouteByName(to.params.navigationPath);
|
|
return targetRoute?.meta?.permissions ?? [];
|
|
}
|
|
|
|
return router.resolve(to)?.meta?.permissions ?? [];
|
|
};
|
|
|
|
const resolveFeatureFlag = to => {
|
|
if (!to) return '';
|
|
|
|
// If navigationPath param exists, get the target route definition
|
|
if (to.params?.navigationPath) {
|
|
const targetRoute = findRouteByName(to.params.navigationPath);
|
|
return targetRoute?.meta?.featureFlag || '';
|
|
}
|
|
|
|
return router.resolve(to)?.meta?.featureFlag || '';
|
|
};
|
|
|
|
const resolveInstallationType = to => {
|
|
if (!to) return [];
|
|
|
|
// If navigationPath param exists, get the target route definition
|
|
if (to.params?.navigationPath) {
|
|
const targetRoute = findRouteByName(to.params.navigationPath);
|
|
return targetRoute?.meta?.installationTypes || [];
|
|
}
|
|
|
|
return router.resolve(to)?.meta?.installationTypes || [];
|
|
};
|
|
|
|
const isAllowed = to => {
|
|
const permissions = resolvePermissions(to);
|
|
const featureFlag = resolveFeatureFlag(to);
|
|
const installationType = resolveInstallationType(to);
|
|
|
|
return shouldShow(featureFlag, permissions, installationType);
|
|
};
|
|
|
|
return {
|
|
...context,
|
|
resolvePath,
|
|
resolvePermissions,
|
|
resolveFeatureFlag,
|
|
isAllowed,
|
|
};
|
|
}
|
|
|
|
export function provideSidebarContext(context) {
|
|
provide(SidebarControl, context);
|
|
}
|