@lokalise/harmony 1.12.6 → 1.13.0

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

@@ -0,0 +1,70 @@
+import { ApiMutationOverrides } from '../../../utils/types/apiMutationOverrides';
+import { Wretch } from 'wretch';
+import { Project, UpdateProjectPathParams, UpdateProjectRequestBody } from '../types/projectTypes';
+/**
+ * A react-query wrapper about the updateProject public API endpoint
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param params - URL parameters
+ * @param overrides - Additional options to pass to the query.
+ */
+export declare function useUpdateProjectMutation<T>(wretchClient: Wretch<T>, params: UpdateProjectPathParams, overrides?: ApiMutationOverrides<Project, UpdateProjectRequestBody>): import('@tanstack/react-query').UseMutationResult<{
+    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;
+    } | undefined;
+    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;
+}, undefined, {
+    name: string;
+    description?: string | undefined;
+}, undefined>;

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

@@ -1076,3 +1076,318 @@ export declare const retrieveProject: import('@lokalise/universal-ts-utils/node'
 }, {
     project_id: string;
 }>, undefined, false, false>;
+/**
+ * Public API router definition for updating a project
+ */
+export declare const updateProject: import('@lokalise/universal-ts-utils/node').PayloadRouteDefinition<{
+    project_id: string;
+}, import('zod').ZodObject<{
+    name: import('zod').ZodString;
+    description: import('zod').ZodOptional<import('zod').ZodString>;
+}, "strip", import('zod').ZodTypeAny, {
+    name: string;
+    description?: string | undefined;
+}, {
+    name: string;
+    description?: string | undefined;
+}>, import('zod').ZodObject<{
+    project_id: import('zod').ZodString;
+    uuid: import('zod').ZodString;
+    project_type: import('zod').ZodUnion<[import('zod').ZodLiteral<"localization_files">, import('zod').ZodLiteral<"paged_documents">, import('zod').ZodLiteral<"marketing">]>;
+    name: import('zod').ZodString;
+    description: import('zod').ZodString;
+    created_at: import('zod').ZodString;
+    created_at_timestamp: import('zod').ZodNumber;
+    created_by: import('zod').ZodNumber;
+    created_by_email: import('zod').ZodString;
+    team_id: import('zod').ZodNumber;
+    base_language_id: import('zod').ZodNumber;
+    base_language_iso: import('zod').ZodString;
+    settings: import('zod').ZodOptional<import('zod').ZodObject<{
+        per_platform_key_names: import('zod').ZodBoolean;
+        reviewing: import('zod').ZodBoolean;
+        auto_toggle_unverified: import('zod').ZodBoolean;
+        offline_translation: import('zod').ZodBoolean;
+        key_editing: import('zod').ZodBoolean;
+        inline_machine_translations: import('zod').ZodBoolean;
+        custom_translation_statuses: import('zod').ZodBoolean;
+        custom_translation_statuses_allow_multiple: import('zod').ZodBoolean;
+        segmentation: import('zod').ZodBoolean;
+        contributor_preview_download_enabled: import('zod').ZodBoolean;
+    }, "strip", import('zod').ZodTypeAny, {
+        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;
+    }, {
+        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: import('zod').ZodOptional<import('zod').ZodObject<{
+        progress_total: import('zod').ZodNumber;
+        keys_total: import('zod').ZodNumber;
+        team: import('zod').ZodNumber;
+        base_words: import('zod').ZodNumber;
+        qa_issues_total: import('zod').ZodNumber;
+        qa_issues: import('zod').ZodObject<{
+            not_reviewed: import('zod').ZodNumber;
+            unverified: import('zod').ZodNumber;
+            spelling_grammar: import('zod').ZodNumber;
+            inconsistent_placeholders: import('zod').ZodNumber;
+            inconsistent_html: import('zod').ZodNumber;
+            different_number_of_urls: import('zod').ZodNumber;
+            different_urls: import('zod').ZodNumber;
+            leading_whitespace: import('zod').ZodNumber;
+            trailing_whitespace: import('zod').ZodNumber;
+            different_number_of_email_address: import('zod').ZodNumber;
+            different_email_address: import('zod').ZodNumber;
+            different_brackets: import('zod').ZodNumber;
+            different_numbers: import('zod').ZodNumber;
+            double_space: import('zod').ZodNumber;
+            special_placeholder: import('zod').ZodNumber;
+            unbalanced_brackets: import('zod').ZodNumber;
+        }, "strip", import('zod').ZodTypeAny, {
+            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;
+        }, {
+            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;
+        }>;
+        languages: import('zod').ZodArray<import('zod').ZodObject<{
+            language_id: import('zod').ZodNumber;
+            language_iso: import('zod').ZodString;
+            progress: import('zod').ZodNumber;
+            words_to_do: import('zod').ZodNumber;
+        }, "strip", import('zod').ZodTypeAny, {
+            progress: number;
+            language_id: number;
+            language_iso: string;
+            words_to_do: number;
+        }, {
+            progress: number;
+            language_id: number;
+            language_iso: string;
+            words_to_do: number;
+        }>, "many">;
+    }, "strip", import('zod').ZodTypeAny, {
+        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;
+        };
+    }, {
+        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;
+        };
+    }>>;
+}, "strip", import('zod').ZodTypeAny, {
+    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;
+    } | undefined;
+    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;
+}, {
+    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;
+    } | undefined;
+    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;
+}>, import('zod').ZodObject<{
+    project_id: import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    project_id: string;
+}, {
+    project_id: string;
+}>, undefined, undefined, false, false>;

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

@@ -1005,3 +1005,22 @@ export declare const RETRIEVE_PROJECT_REQUEST_QUERY_SCHEMA: z.ZodObject<{
 }, {
     project_id: string;
 }>;
+export declare const UPDATE_PROJECT_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    project_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    project_id: string;
+}, {
+    project_id: string;
+}>;
+export type UpdateProjectPathParams = z.infer<typeof UPDATE_PROJECT_PATH_PARAMS_SCHEMA>;
+export declare const UPDATE_PROJECT_REQUEST_BODY_SCHEMA: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    description?: string | undefined;
+}, {
+    name: string;
+    description?: string | undefined;
+}>;
+export type UpdateProjectRequestBody = z.infer<typeof UPDATE_PROJECT_REQUEST_BODY_SCHEMA>;

package/package.json

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