@lokalise/harmony 1.10.0 → 1.11.0

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

@@ -0,0 +1,34 @@
+import { RetrieveContributorsResponse } from '../types/contributorTypes';
+import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
+import { Wretch } from 'wretch';
+/**
+ * Factory for creating keys for the useRetrieveContributorQuery hook
+ */
+export declare const retrieveContributorKeys: {
+    projectUserKey: (projectId: string, userId: number) => readonly ["RetrieveContributor", string, number];
+};
+/**
+ * A react-router wrapper about the retrieveContributor public API endpoint
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param overrides - Additional options to pass to the query.
+ */
+export declare const useRetrieveContributorQuery: <T>(wretchClient: Wretch<T>, overrides: ApiQueryOverrides<RetrieveContributorsResponse, typeof retrieveContributorKeys>) => import('@tanstack/react-query').UseQueryResult<{
+    contributors: {
+        email: string;
+        user_id: number;
+        fullname: string;
+        created_at: string;
+        created_at_timestamp: number;
+        admin_rights: string[];
+        languages: {
+            lang_id: number;
+            lang_iso: string;
+            lang_name: string;
+            is_writable: 0 | 1;
+        }[];
+        is_admin: boolean;
+        is_reviewer: boolean;
+    }[];
+    project_id: string;
+}, undefined>;

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

@@ -0,0 +1,72 @@
+import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
+import { Wretch } from 'wretch';
+import { Project } from '../types/projectTypes';
+/**
+ * Factory function to create the query key for the retrieveProject query
+ */
+export declare const retrieveProjectQueryKey: {
+    projectIdKey: (projectId: string) => string[];
+};
+/**
+ * A react-router wrapper about the retrieveProject public API endpoint
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param overrides - Additional options to pass to the query.
+ */
+export declare function useRetrieveProjectQuery<T>(wretchClient: Wretch<T>, overrides: ApiQueryOverrides<Project, typeof retrieveProjectQueryKey>): import('@tanstack/react-query').UseQueryResult<{
+    name: string;
+    created_at: string;
+    created_at_timestamp: number;
+    team_id: number;
+    description: string;
+    project_id: string;
+    uuid: string;
+    project_type: "localization_files" | "paged_documents" | "marketing";
+    created_by: number;
+    created_by_email: string;
+    base_language_id: number;
+    base_language_iso: string;
+    settings: {
+        per_platform_key_names: boolean;
+        reviewing: boolean;
+        auto_toggle_unverified: boolean;
+        offline_translation: boolean;
+        key_editing: boolean;
+        inline_machine_translations: boolean;
+        custom_translation_statuses: boolean;
+        custom_translation_statuses_allow_multiple: boolean;
+        segmentation: boolean;
+        contributor_preview_download_enabled: boolean;
+    };
+    statistics: {
+        team: number;
+        languages: {
+            progress: number;
+            language_id: number;
+            language_iso: string;
+            words_to_do: number;
+        }[];
+        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>;

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

@@ -0,0 +1,16 @@
+export * from './contributors';
+export * from './projects';
+export * from './teamUsers';
+export * from './userToken';
+export type { LanguageStatistics, LanguageIso } from './types/languageTypes';
+export type { Project, ProjectQaIssues, ProjectType, ProjectSettings } from './types/projectTypes';
+export type { TeamRole } from './types/teamRoleTypes';
+export type { Contributor, ContributorLanguage } from './types/contributorTypes';
+export type { TeamUser } from './types/teamUserTypes';
+export type { AuthenticatedRequestHeader, JwtToken } from './types/userTokenTypes';
+export * from './hooks/useCreateProjectMutation';
+export * from './hooks/useGetTeamUsersQuery';
+export * from './hooks/useGetUserTokenQuery';
+export * from './hooks/useListProjectsQuery';
+export * from './hooks/useRetrieveContributorQuery';
+export * from './hooks/useRetrieveProjectQuery';