@lokalise/harmony 1.37.0 → 1.38.0

package/dist/types/src/features/navigation/ProjectNavigationPanel.d.ts

@@ -0,0 +1,13 @@
+import { NavigationConfig } from './core/NavigationClient';
+import { Project } from '../node';
+import { Page } from './types/navigation';
+export interface ProjectNavigationPanelProps {
+    projectId: Project['project_id'];
+    page: Page;
+    config: NavigationConfig;
+}
+/**
+ * Complete self-contained ProjectNavigationPanel with all providers included.
+ * No external setup required - just pass config and use.
+ */
+export declare const ProjectNavigationPanel: ({ config, ...props }: ProjectNavigationPanelProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/src/features/navigation/core/NavigationClient.d.ts

@@ -0,0 +1,23 @@
+import { Wretch } from 'wretch';
+import { FormDataAddon as FormDataAddonType } from 'wretch/addons/formData';
+export interface NavigationConfig {
+    expertAppUrl: string;
+    nextgenAppUrl: string;
+    expertPublicApiUrl: string;
+    nextgenApiUrl: string;
+}
+export declare class NavigationClient {
+    private config;
+    private publicApiClient;
+    private authorizedApiClient;
+    constructor(config: NavigationConfig);
+    private createPublicApiClient;
+    private createAuthorizedApiClient;
+    getConfig(): NavigationConfig;
+    getPublicApiClient(): Wretch<unknown, unknown, undefined>;
+    getAuthorizedApiClient(): FormDataAddonType & Wretch<FormDataAddonType, unknown, undefined>;
+    getExpertUrl(): string;
+    getNextgenUrl(): string;
+    getExpertPublicApiUrl(): string;
+    getNextgenApiUrl(): string;
+}

package/dist/types/src/features/navigation/hooks/useExpertNavigation.d.ts

@@ -0,0 +1,8 @@
+import { Contributor, Project } from '../../node';
+import { NavigationTabsItem } from '../types/navigation';
+export declare const getIsFeatureEnabled: (features: Record<string, boolean>, name: string) => boolean;
+/**
+ * Hook to generate legacy navigation items using the existing structure
+ * but with context API instead of Redux
+ */
+export declare const useExpertNavigation: (enabled: boolean, project?: Project, contributor?: Contributor) => NavigationTabsItem[];

package/dist/types/src/features/navigation/hooks/useNavigation.d.ts

@@ -0,0 +1,18 @@
+import { Contributor, Project, ProjectType } from '../../node';
+export declare const isLegacyProject: (type: ProjectType | undefined) => type is "localization_files" | "paged_documents" | "content_integration" | undefined;
+/**
+ * Main useNavigation hook that serves as an arbiter between legacy and new navigation.
+ * It determines which navigation system to use based on project type.
+ */
+export declare const useNavigation: (activeKey: string, project?: Project, contributorData?: Contributor) => import('../types/navigation').NavigationTabsItem[] | {
+    key: import('../schemas/navigationSchema').NavKey;
+    label: string;
+    icon: import('../types/navigation').NavItemIcon | undefined;
+    visible: boolean;
+    badge: number | undefined;
+    disabled: boolean;
+    dropdown: import('../types/navigation').DropdownItem[][] | undefined;
+    isActive: (input: string) => boolean;
+    link: string;
+    onClick: () => void;
+}[];

package/dist/types/src/features/navigation/hooks/useNavigationQueries.d.ts

@@ -0,0 +1,279 @@
+/**
+ * Hook to fetch project data for navigation
+ */
+export declare function useNavigationProjectQuery(projectId: string): import('@tanstack/react-query').UseQueryResult<{
+    name: string;
+    created_at: string;
+    created_at_timestamp: number;
+    team_id: number;
+    description: string;
+    uuid: string;
+    project_id: string;
+    project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
+    created_by: number;
+    created_by_email: string;
+    team_uuid: string;
+    base_language_id: number;
+    base_language_iso: string;
+    base_project_language_id: number;
+    base_project_language_uuid: string;
+    settings?: {
+        per_platform_key_names: boolean;
+        reviewing: boolean;
+        auto_toggle_unverified: boolean;
+        offline_translation: boolean;
+        key_editing: boolean;
+        branching: boolean;
+        inline_machine_translations: boolean;
+        custom_translation_statuses: boolean;
+        custom_translation_statuses_allow_multiple: boolean;
+        segmentation: boolean;
+        contributor_preview_download_enabled: boolean;
+    } | undefined;
+    statistics?: {
+        team: number;
+        languages: {
+            progress: number;
+            language_id: number;
+            language_iso: string;
+            words_to_do: number;
+            project_language_id: number;
+            project_language_uuid: string;
+        }[];
+        progress_total: number;
+        keys_total: number;
+        base_words: number;
+        qa_issues_total: number;
+        qa_issues: {
+            not_reviewed: number;
+            unverified: number;
+            spelling_grammar: number;
+            inconsistent_placeholders: number;
+            inconsistent_html: number;
+            different_number_of_urls: number;
+            different_urls: number;
+            leading_whitespace: number;
+            trailing_whitespace: number;
+            different_number_of_email_address: number;
+            different_email_address: number;
+            different_brackets: number;
+            different_numbers: number;
+            double_space: number;
+            special_placeholder: number;
+            unbalanced_brackets: number;
+        };
+    } | undefined;
+}, undefined>;
+/**
+ * Hook to fetch contributor data for navigation
+ */
+export declare function useNavigationContributorQuery(projectId: string): import('@tanstack/react-query').UseQueryResult<{
+    project_id: string;
+    contributor: {
+        email: string;
+        user_id: number;
+        fullname: string;
+        created_at: string;
+        created_at_timestamp: number;
+        avatar_url: string;
+        languages: {
+            lang_id: number;
+            lang_iso: string;
+            lang_name: string;
+            is_writable: boolean | 0 | 1;
+        }[];
+        admin_rights: string[];
+        permissions: string[];
+        role_id: number | null;
+        is_owner: boolean;
+        is_admin: boolean;
+        is_reviewer: boolean;
+        is_pending: boolean;
+        is_reinvited: boolean;
+    };
+}, undefined>;
+/**
+ * Composite hook that fetches all navigation data
+ */
+export declare function useNavigationData(projectId: string): {
+    projectQuery: import('@tanstack/react-query').UseQueryResult<{
+        name: string;
+        created_at: string;
+        created_at_timestamp: number;
+        team_id: number;
+        description: string;
+        uuid: string;
+        project_id: string;
+        project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
+        created_by: number;
+        created_by_email: string;
+        team_uuid: string;
+        base_language_id: number;
+        base_language_iso: string;
+        base_project_language_id: number;
+        base_project_language_uuid: string;
+        settings?: {
+            per_platform_key_names: boolean;
+            reviewing: boolean;
+            auto_toggle_unverified: boolean;
+            offline_translation: boolean;
+            key_editing: boolean;
+            branching: boolean;
+            inline_machine_translations: boolean;
+            custom_translation_statuses: boolean;
+            custom_translation_statuses_allow_multiple: boolean;
+            segmentation: boolean;
+            contributor_preview_download_enabled: boolean;
+        } | undefined;
+        statistics?: {
+            team: number;
+            languages: {
+                progress: number;
+                language_id: number;
+                language_iso: string;
+                words_to_do: number;
+                project_language_id: number;
+                project_language_uuid: string;
+            }[];
+            progress_total: number;
+            keys_total: number;
+            base_words: number;
+            qa_issues_total: number;
+            qa_issues: {
+                not_reviewed: number;
+                unverified: number;
+                spelling_grammar: number;
+                inconsistent_placeholders: number;
+                inconsistent_html: number;
+                different_number_of_urls: number;
+                different_urls: number;
+                leading_whitespace: number;
+                trailing_whitespace: number;
+                different_number_of_email_address: number;
+                different_email_address: number;
+                different_brackets: number;
+                different_numbers: number;
+                double_space: number;
+                special_placeholder: number;
+                unbalanced_brackets: number;
+            };
+        } | undefined;
+    }, undefined>;
+    contributorQuery: import('@tanstack/react-query').UseQueryResult<{
+        project_id: string;
+        contributor: {
+            email: string;
+            user_id: number;
+            fullname: string;
+            created_at: string;
+            created_at_timestamp: number;
+            avatar_url: string;
+            languages: {
+                lang_id: number;
+                lang_iso: string;
+                lang_name: string;
+                is_writable: boolean | 0 | 1;
+            }[];
+            admin_rights: string[];
+            permissions: string[];
+            role_id: number | null;
+            is_owner: boolean;
+            is_admin: boolean;
+            is_reviewer: boolean;
+            is_pending: boolean;
+            is_reinvited: boolean;
+        };
+    }, undefined>;
+    data: {
+        project: {
+            name: string;
+            created_at: string;
+            created_at_timestamp: number;
+            team_id: number;
+            description: string;
+            uuid: string;
+            project_id: string;
+            project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
+            created_by: number;
+            created_by_email: string;
+            team_uuid: string;
+            base_language_id: number;
+            base_language_iso: string;
+            base_project_language_id: number;
+            base_project_language_uuid: string;
+            settings?: {
+                per_platform_key_names: boolean;
+                reviewing: boolean;
+                auto_toggle_unverified: boolean;
+                offline_translation: boolean;
+                key_editing: boolean;
+                branching: boolean;
+                inline_machine_translations: boolean;
+                custom_translation_statuses: boolean;
+                custom_translation_statuses_allow_multiple: boolean;
+                segmentation: boolean;
+                contributor_preview_download_enabled: boolean;
+            } | undefined;
+            statistics?: {
+                team: number;
+                languages: {
+                    progress: number;
+                    language_id: number;
+                    language_iso: string;
+                    words_to_do: number;
+                    project_language_id: number;
+                    project_language_uuid: string;
+                }[];
+                progress_total: number;
+                keys_total: number;
+                base_words: number;
+                qa_issues_total: number;
+                qa_issues: {
+                    not_reviewed: number;
+                    unverified: number;
+                    spelling_grammar: number;
+                    inconsistent_placeholders: number;
+                    inconsistent_html: number;
+                    different_number_of_urls: number;
+                    different_urls: number;
+                    leading_whitespace: number;
+                    trailing_whitespace: number;
+                    different_number_of_email_address: number;
+                    different_email_address: number;
+                    different_brackets: number;
+                    different_numbers: number;
+                    double_space: number;
+                    special_placeholder: number;
+                    unbalanced_brackets: number;
+                };
+            } | undefined;
+        } | undefined;
+        contributor: {
+            email: string;
+            user_id: number;
+            fullname: string;
+            created_at: string;
+            created_at_timestamp: number;
+            avatar_url: string;
+            languages: {
+                lang_id: number;
+                lang_iso: string;
+                lang_name: string;
+                is_writable: boolean | 0 | 1;
+            }[];
+            admin_rights: string[];
+            permissions: string[];
+            role_id: number | null;
+            is_owner: boolean;
+            is_admin: boolean;
+            is_reviewer: boolean;
+            is_pending: boolean;
+            is_reinvited: boolean;
+        } | undefined;
+    };
+    isLoading: boolean;
+    error: null | undefined;
+    isAnyLoading: boolean;
+    hasAllData: boolean;
+    refetchAll: () => void;
+};

package/dist/types/src/features/navigation/hooks/useNextgenNavigation.d.ts

@@ -0,0 +1,16 @@
+import { Contributor, Project } from '../../node';
+/**
+ * Hook to generate navigation items for new applications
+ */
+export declare const useNextgenNavigation: (activeKey: string, enabled: boolean, project?: Project, contributor?: Contributor) => {
+    key: import('../schemas/navigationSchema').NavKey;
+    label: string;
+    icon: import('../types/navigation').NavItemIcon | undefined;
+    visible: boolean;
+    badge: number | undefined;
+    disabled: boolean;
+    dropdown: import('../types/navigation').DropdownItem[][] | undefined;
+    isActive: (input: string) => boolean;
+    link: string;
+    onClick: () => void;
+}[];

package/dist/types/src/features/navigation/providers/NavigationClientProvider.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+import { NavigationClient } from '../core/NavigationClient';
+interface NavigationClientProviderProps {
+    client: NavigationClient;
+    children: ReactNode;
+}
+export declare const NavigationClientProvider: ({ client, children }: NavigationClientProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useNavigationClient: () => NavigationClient;
+export {};

package/dist/types/src/features/navigation/schemas/navigationSchema.d.ts

@@ -0,0 +1,22 @@
+import { DropdownItem, NavItemIcon } from '../types/navigation';
+export type NavKey = 'editor' | 'contributors' | 'orders' | 'billing' | 'settings' | 'dashboard';
+export interface NavigationItem {
+    key: NavKey;
+    labelKey: string;
+    path: ({ projectId }: {
+        projectId: string;
+    }) => string;
+    icon?: NavItemIcon;
+    dropdown?: DropdownItem[][];
+    badge?: number | ((ctx: NavCtx) => number);
+    shouldShow?: (ctx: NavCtx) => boolean;
+    disabled?: boolean | ((ctx: NavCtx) => boolean);
+    isActive?: (pathname: string) => boolean;
+}
+/** What the gate functions receive */
+export interface NavCtx {
+    flags: Record<string, string>;
+    pathname: string;
+    permissions?: Array<string>;
+}
+export declare const navigationItems: NavigationItem[];

package/dist/types/src/{components/NavigationPanel → features/navigation}/types/navigation.d.ts

@@ -19,3 +19,4 @@ export type DropdownItem = {
     link?: string;
     onClick?: () => void;
 };
+export type Page = 'contributors';

package/dist/types/src/features/navigation/utils/toolbarVisibility.d.ts

@@ -0,0 +1,28 @@
+import { Project } from '../../node';
+type ToolbarVisibility = {
+    disabled: boolean;
+    visible: boolean;
+};
+export type ToolbarVisibilityMap = {
+    upload: ToolbarVisibility;
+    download: ToolbarVisibility;
+    apps: ToolbarVisibility;
+    contentManagement: ToolbarVisibility;
+    editor: ToolbarVisibility;
+    files: ToolbarVisibility;
+    tasks: ToolbarVisibility;
+    workflows: ToolbarVisibility;
+    contributors: ToolbarVisibility;
+    screenshots: ToolbarVisibility;
+    glossary: ToolbarVisibility;
+    more: ToolbarVisibility;
+    settings: ToolbarVisibility;
+    branches: ToolbarVisibility;
+    otaBundles: ToolbarVisibility;
+    automations: ToolbarVisibility;
+    duplicateFinder: ToolbarVisibility;
+    activity: ToolbarVisibility;
+    statistics: ToolbarVisibility;
+};
+export declare const getProjectNavigationVisibilityMap: (project: Project, adminRights: string[], isFeatureEnabled: (key: string) => boolean) => ToolbarVisibilityMap;
+export {};

package/dist/types/src/features/publicApi/hooks/useCreateProjectMutation.d.ts

@@ -17,7 +17,7 @@ export declare function useCreateProjectMutation<T>(wretchClient: Wretch<T>, hea
     description: string;
     uuid: string;
     project_id: string;
-    project_type: "localization_files" | "paged_documents" | "marketing";
+    project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
     created_by: number;
     created_by_email: string;
     team_uuid: string;
@@ -31,6 +31,7 @@ export declare function useCreateProjectMutation<T>(wretchClient: Wretch<T>, hea
         auto_toggle_unverified: boolean;
         offline_translation: boolean;
         key_editing: boolean;
+        branching: boolean;
         inline_machine_translations: boolean;
         custom_translation_statuses: boolean;
         custom_translation_statuses_allow_multiple: boolean;
@@ -77,7 +78,7 @@ export declare function useCreateProjectMutation<T>(wretchClient: Wretch<T>, hea
         lang_iso: string;
         custom_iso?: string | undefined;
     }[];
-    project_type: "localization_files" | "paged_documents" | "marketing";
+    project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
     base_lang_iso: string;
     is_segmentation_enabled: boolean;
 }, undefined>;

package/dist/types/src/features/publicApi/hooks/useListProjectsQuery.d.ts

@@ -8,7 +8,7 @@ import { Wretch } from 'wretch';
 export declare const listProjectsKey: {
     paramsKey: (params: ListProjectsRequestQuery) => readonly ["listProjects", {
         page?: number | undefined;
-        filter_type?: "localization_files" | "paged_documents" | "marketing" | undefined;
+        filter_type?: "localization_files" | "paged_documents" | "marketing" | "content_integration" | undefined;
         filter_team_id?: number | undefined;
         filter_names?: string | undefined;
         include_statistics?: 0 | 1 | undefined;
@@ -32,7 +32,7 @@ export declare function useListProjectsQuery<T>(wretchClient: Wretch<T>, headers
         description: string;
         uuid: string;
         project_id: string;
-        project_type: "localization_files" | "paged_documents" | "marketing";
+        project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
         created_by: number;
         created_by_email: string;
         team_uuid: string;
@@ -46,6 +46,7 @@ export declare function useListProjectsQuery<T>(wretchClient: Wretch<T>, headers
             auto_toggle_unverified: boolean;
             offline_translation: boolean;
             key_editing: boolean;
+            branching: boolean;
             inline_machine_translations: boolean;
             custom_translation_statuses: boolean;
             custom_translation_statuses_allow_multiple: boolean;

package/dist/types/src/features/publicApi/hooks/useRetrieveProjectQuery.d.ts

@@ -23,7 +23,7 @@ export declare function useRetrieveProjectQuery<T>(wretchClient: Wretch<T>, head
     description: string;
     uuid: string;
     project_id: string;
-    project_type: "localization_files" | "paged_documents" | "marketing";
+    project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
     created_by: number;
     created_by_email: string;
     team_uuid: string;
@@ -37,6 +37,7 @@ export declare function useRetrieveProjectQuery<T>(wretchClient: Wretch<T>, head
         auto_toggle_unverified: boolean;
         offline_translation: boolean;
         key_editing: boolean;
+        branching: boolean;
         inline_machine_translations: boolean;
         custom_translation_statuses: boolean;
         custom_translation_statuses_allow_multiple: boolean;

package/dist/types/src/features/publicApi/hooks/useUpdateProjectMutation.d.ts

@@ -18,7 +18,7 @@ export declare function useUpdateProjectMutation<T>(wretchClient: Wretch<T>, hea
     description: string;
     uuid: string;
     project_id: string;
-    project_type: "localization_files" | "paged_documents" | "marketing";
+    project_type: "localization_files" | "paged_documents" | "marketing" | "content_integration";
     created_by: number;
     created_by_email: string;
     team_uuid: string;
@@ -32,6 +32,7 @@ export declare function useUpdateProjectMutation<T>(wretchClient: Wretch<T>, hea
         auto_toggle_unverified: boolean;
         offline_translation: boolean;
         key_editing: boolean;
+        branching: boolean;
         inline_machine_translations: boolean;
         custom_translation_statuses: boolean;
         custom_translation_statuses_allow_multiple: boolean;