@lokalise/harmony 1.15.0 → 1.16.0

package/dist/types/src/components/Sidebar/Sidebar.d.ts

@@ -46,5 +46,8 @@ declare const Sidebar: {
         onClick?: () => void;
         hideBottomDivider?: boolean;
     }) => import("react/jsx-runtime").JSX.Element | null;
+    Tasks: (props: {
+        config: import('./Widgets/Tasks/types').SidebarTasksConfig;
+    }) => import("react/jsx-runtime").JSX.Element;
 };
 export { Sidebar };

package/dist/types/src/components/Sidebar/Widgets/Tasks/TaskLanguage/TaskLanguage.d.ts

@@ -0,0 +1,6 @@
+import { SidebarTask, SidebarTaskLanguage } from '../types';
+export type TaskLanguageProps = {
+    task: SidebarTask;
+    language: SidebarTaskLanguage;
+};
+export declare const TaskLanguage: ({ language, task }: TaskLanguageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/src/components/Sidebar/Widgets/Tasks/TaskLanguageCompleted/TaskLanguageCompleted.d.ts

@@ -0,0 +1,7 @@
+import { SidebarTask, SidebarTaskLanguage } from '../types';
+type TaskLanguageCompletedProps = {
+    task: SidebarTask;
+    language: SidebarTaskLanguage;
+};
+export declare const TaskLanguageCompleted: ({ task, language }: TaskLanguageCompletedProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/src/components/Sidebar/Widgets/Tasks/TaskOverview/TaskOverview.d.ts

@@ -0,0 +1,5 @@
+import { SidebarTask } from '../types';
+export type TaskProps = {
+    task: SidebarTask;
+};
+export declare const TaskOverview: ({ task }: TaskProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/src/components/Sidebar/Widgets/Tasks/Tasks.d.ts

@@ -0,0 +1,3 @@
+export declare const Tasks: (props: {
+    config: import('./types').SidebarTasksConfig;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/types/src/components/Sidebar/Widgets/Tasks/Tasks.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/components/Sidebar/Widgets/Tasks/TasksContext.d.ts

@@ -0,0 +1,3 @@
+import { SidebarTasksContextProps } from './types';
+export declare const TasksContext: import('react').Context<SidebarTasksContextProps>;
+export declare const useTasks: () => SidebarTasksContextProps;

package/dist/types/src/components/Sidebar/Widgets/Tasks/TasksPopover/TasksPopover.d.ts

@@ -0,0 +1 @@
+export declare const TasksPopover: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/src/components/Sidebar/Widgets/Tasks/TasksProvider.d.ts

@@ -0,0 +1,10 @@
+import { FC, PropsWithChildren } from 'react';
+import { SidebarTasksConfig } from './types';
+type TasksProviderProps = PropsWithChildren<{
+    config: SidebarTasksConfig;
+}>;
+export declare const TasksProvider: ({ children, config }: TasksProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const withTasksContext: <P extends {
+    config: SidebarTasksConfig;
+}>(WrappedComponent: FC<Omit<P, "config">>) => (props: P) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/src/components/Sidebar/Widgets/Tasks/index.d.ts

@@ -0,0 +1,2 @@
+export { Tasks } from './Tasks';
+export { dispatchTaskEvent, TaskEvents } from './utils/taskEvents';

package/dist/types/src/components/Sidebar/Widgets/Tasks/types.d.ts

@@ -0,0 +1,86 @@
+import { TypesFromMap } from '../../../../utils/typeUtils';
+export declare const SidebarTaskStatuses: {
+    readonly Completed: "completed";
+    readonly InProgress: "in_progress";
+    readonly Created: "created";
+    readonly Queued: "queued";
+};
+export type SidebarTaskStatus = TypesFromMap<typeof SidebarTaskStatuses>;
+export declare const SidebarTaskLanguageStatuses: {
+    readonly NotStarted: "not_started";
+    readonly Completed: "completed";
+    readonly InProgress: "in_progress";
+    readonly Created: "created";
+    readonly Queued: "queued";
+};
+export type SidebarTaskLanguageStatus = TypesFromMap<typeof SidebarTaskLanguageStatuses>;
+export declare const SidebarTaskTypeOptions: {
+    readonly translation: "translation";
+    readonly review: "review";
+    readonly lqa_by_ai: "lqa_by_ai";
+    readonly automatic_translation: "automatic_translation";
+};
+export type SidebarTaskTypeOption = TypesFromMap<typeof SidebarTaskTypeOptions>;
+export type SidebarTaskStyleGuide = {
+    id: string;
+    name: string;
+};
+export type SidebarTaskLanguage = {
+    lang_id: string;
+    name: string;
+    progress?: number;
+    status: SidebarTaskLanguageStatus;
+    base_words_total: number;
+    base_words_done: number;
+};
+export type SidebarTask = {
+    id: string;
+    title: string;
+    status: SidebarTaskStatus;
+    langs: SidebarTaskLanguage[];
+    team_id: number;
+    created_by_fullname: string;
+    source_lang_name: string;
+    task_type: SidebarTaskTypeOption;
+    style_guides: SidebarTaskStyleGuide[];
+    description?: string;
+    project_name: string;
+    master_branching_enabled: '0' | '1';
+    branch_name: string | null;
+    due_date: string | null;
+};
+export type SidebarDefaultFnArgs = {
+    task: SidebarTask;
+    language: SidebarTaskLanguage;
+};
+export type SidebarDefaultFn = (props: SidebarDefaultFnArgs) => void;
+export type SidebarTasksGetProjectUrlFnArgs = {
+    task: SidebarTask;
+    language?: SidebarTaskLanguage;
+    view?: 'single' | 'multi';
+    taskUncompleted?: boolean;
+};
+export type SidebarTasksGetProjectUrlFn = (props: SidebarTasksGetProjectUrlFnArgs) => string;
+export type SidebarTaskTitleOnClickFn = (props: Pick<SidebarDefaultFnArgs, 'task'>) => void;
+export type SidebarOnLanguageCompleteConfirmFnArgs = SidebarDefaultFnArgs & {
+    closePrompt: () => void;
+};
+export type SidebarOnLanguageCompleteConfirmFn = (props: SidebarOnLanguageCompleteConfirmFnArgs) => Promise<void>;
+export type SidebarTasksConfig = {
+    getTasksCount: () => Promise<number>;
+    getTasks: () => Promise<SidebarTask[]>;
+    getProjectUrl: SidebarTasksGetProjectUrlFn;
+    onLanguageCompleteConfirm: SidebarOnLanguageCompleteConfirmFn;
+    onTasksWidgetOpen?: ({ tasks }: {
+        tasks: SidebarTask[];
+    }) => void;
+    taskTitleOnClick?: SidebarTaskTitleOnClickFn;
+    langNameOnClick?: SidebarDefaultFn;
+    langProgressOnClick?: SidebarDefaultFn;
+};
+export type SidebarTasksContextProps = Pick<SidebarTasksConfig, 'onTasksWidgetOpen' | 'getProjectUrl' | 'taskTitleOnClick' | 'langNameOnClick' | 'langProgressOnClick' | 'onLanguageCompleteConfirm'> & {
+    fetchTasks: () => Promise<void>;
+    tasks: SidebarTask[];
+    tasksCount: number;
+    loadingTasks: boolean;
+};

package/dist/types/src/components/Sidebar/Widgets/Tasks/utils/content.d.ts

@@ -0,0 +1,16 @@
+import { SidebarTask, SidebarTaskLanguage, SidebarTaskLanguageStatus, SidebarTaskTypeOption } from '../types';
+export declare const getStatusText: (status: SidebarTaskLanguageStatus, progressValue: number) => "Closed" | "Completed" | "In progress" | "Not started" | "Queued" | "-";
+export declare const resolveStatus: (language: SidebarTaskLanguage) => SidebarTaskLanguageStatus;
+/**
+ * TODO - these should be taken from louis
+ */
+export declare const tagColor: Record<SidebarTaskTypeOption, string>;
+export declare const getTaskLanguages: (langs: SidebarTaskLanguage[]) => {
+    status: SidebarTaskLanguageStatus;
+    lang_id: string;
+    name: string;
+    progress?: number;
+    base_words_total: number;
+    base_words_done: number;
+}[];
+export declare const isLanguageProgressCompleted: (task: SidebarTask, language: SidebarTaskLanguage) => boolean;

package/dist/types/src/components/Sidebar/Widgets/Tasks/utils/taskEvents.d.ts

@@ -0,0 +1,24 @@
+import { TypesFromMap } from '../../../../../utils/node.ts';
+export declare const TaskEvents: {
+    readonly TaskCompleted: "task_completed";
+    readonly TaskClosed: "task_closed";
+    readonly Refresh: "refresh";
+    readonly ShowDialog: "show_dialog";
+};
+export type TaskEvent = TypesFromMap<typeof TaskEvents>;
+type SingleTaskPayload = {
+    taskId: string | number;
+};
+type DispatchTaskEventPayload = {
+    name: typeof TaskEvents.TaskCompleted;
+    detail: SingleTaskPayload;
+} | {
+    name: typeof TaskEvents.TaskClosed;
+    detail: SingleTaskPayload;
+} | {
+    name: typeof TaskEvents.Refresh;
+} | {
+    name: typeof TaskEvents.ShowDialog;
+};
+export declare const dispatchTaskEvent: (props: DispatchTaskEventPayload) => void;
+export {};

package/dist/types/src/features/publicApi/node.d.ts

@@ -1,4 +1,5 @@
 export * from './contributors';
+export * from './languages';
 export * from './projects';
 export * from './teamUsers';
 export * from './userToken';

package/dist/types/src/node.d.ts

@@ -2,6 +2,7 @@
  * COMPONENTS EXPORTS
  */
 export * from './components/Sidebar/Widgets/ProfileMenu/types';
+export * from './components/Sidebar/Widgets/Tasks/types';
 export { NavigationPanel } from './components/NavigationPanel/NavigationPanel';
 export { Sidebar } from './components/Sidebar/Sidebar';
 export { Breadcrumbs } from './components/NavigationPanel/components/Breadcrumbs/Breadcrumbs';

package/dist/types/tests/mocks/sidebar/tasks.d.ts

@@ -0,0 +1,2 @@
+import { SidebarTask } from '../../../src/components/Sidebar/Widgets/Tasks/types';
+export declare const createTask: () => SidebarTask;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/harmony",
-    "version": "1.15.0",
+    "version": "1.16.0",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com/"