@lokalise/harmony 1.34.3 → 1.35.0

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

@@ -466,3 +466,535 @@ export declare const retrieveContributor: import('@lokalise/api-contracts').GetR
 }, {
     'X-LOKALISE-PLUGIN': string;
 }>]>>, false, false>;
+/**
+ * Public API router definition for adding project contributors
+ */
+export declare const addContributors: import('@lokalise/api-contracts').PayloadRouteDefinition<{
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+}, import('zod').ZodObject<{
+    contributors: import('zod').ZodArray<import('zod').ZodObject<{
+        email: import('zod').ZodString;
+        fullname: import('zod').ZodOptional<import('zod').ZodString>;
+        is_admin: import('zod').ZodOptional<import('zod').ZodBoolean>;
+        is_reviewer: import('zod').ZodOptional<import('zod').ZodBoolean>;
+        role_id: import('zod').ZodOptional<import('zod').ZodNumber>;
+        admin_rights: import('zod').ZodOptional<import('zod').ZodArray<import('zod').ZodString, "many">>;
+        languages: import('zod').ZodArray<import('zod').ZodObject<{
+            lang_iso: import('zod').ZodString;
+            is_writable: import('zod').ZodOptional<import('zod').ZodBoolean>;
+        }, "strip", import('zod').ZodTypeAny, {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }, {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }>, "many">;
+    }, "strip", import('zod').ZodTypeAny, {
+        email: string;
+        languages: {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }[];
+        fullname?: string | undefined;
+        admin_rights?: string[] | undefined;
+        role_id?: number | undefined;
+        is_admin?: boolean | undefined;
+        is_reviewer?: boolean | undefined;
+    }, {
+        email: string;
+        languages: {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }[];
+        fullname?: string | undefined;
+        admin_rights?: string[] | undefined;
+        role_id?: number | undefined;
+        is_admin?: boolean | undefined;
+        is_reviewer?: boolean | undefined;
+    }>, "many">;
+}, "strip", import('zod').ZodTypeAny, {
+    contributors: {
+        email: string;
+        languages: {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }[];
+        fullname?: string | undefined;
+        admin_rights?: string[] | undefined;
+        role_id?: number | undefined;
+        is_admin?: boolean | undefined;
+        is_reviewer?: boolean | undefined;
+    }[];
+}, {
+    contributors: {
+        email: string;
+        languages: {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }[];
+        fullname?: string | undefined;
+        admin_rights?: string[] | undefined;
+        role_id?: number | undefined;
+        is_admin?: boolean | undefined;
+        is_reviewer?: boolean | undefined;
+    }[];
+}>, import('zod').ZodObject<{
+    project_id: import('zod').ZodString;
+    contributor: import('zod').ZodObject<{
+        user_id: import('zod').ZodNumber;
+        email: import('zod').ZodString;
+        fullname: import('zod').ZodString;
+        avatar_url: import('zod').ZodString;
+        created_at: import('zod').ZodString;
+        created_at_timestamp: import('zod').ZodNumber;
+        languages: import('zod').ZodArray<import('zod').ZodObject<{
+            lang_id: import('zod').ZodNumber;
+            lang_iso: import('zod').ZodString;
+            lang_name: import('zod').ZodString;
+            is_writable: import('zod').ZodUnion<[import('zod').ZodLiteral<0>, import('zod').ZodLiteral<1>, import('zod').ZodBoolean]>;
+        }, "strip", import('zod').ZodTypeAny, {
+            lang_id: number;
+            lang_iso: string;
+            lang_name: string;
+            is_writable: boolean | 0 | 1;
+        }, {
+            lang_id: number;
+            lang_iso: string;
+            lang_name: string;
+            is_writable: boolean | 0 | 1;
+        }>, "many">;
+        admin_rights: import('zod').ZodArray<import('zod').ZodString, "many">;
+        permissions: import('zod').ZodArray<import('zod').ZodString, "many">;
+        role_id: import('zod').ZodNullable<import('zod').ZodNumber>;
+        is_owner: import('zod').ZodBoolean;
+        is_admin: import('zod').ZodBoolean;
+        is_reviewer: import('zod').ZodBoolean;
+        is_pending: import('zod').ZodBoolean;
+        is_reinvited: import('zod').ZodBoolean;
+    }, "strip", import('zod').ZodTypeAny, {
+        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;
+    }, {
+        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;
+    }>;
+}, "strip", import('zod').ZodTypeAny, {
+    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;
+    };
+}, {
+    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;
+    };
+}>, import('zod').ZodObject<{
+    project: import('zod').ZodUnion<[import('zod').ZodObject<{
+        uuid: import('zod').ZodString;
+    }, "strip", import('zod').ZodTypeAny, {
+        uuid: string;
+    }, {
+        uuid: string;
+    }>, import('zod').ZodObject<{
+        id: import('zod').ZodString;
+    }, "strip", import('zod').ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>]>;
+}, "strip", import('zod').ZodTypeAny, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+}, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+}>, undefined, import('zod').ZodIntersection<import('zod').ZodUnion<[import('zod').ZodUnion<[import('zod').ZodObject<{
+    authorization: import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    authorization: string;
+}, {
+    authorization: string;
+}>, import('zod').ZodObject<{
+    AUTHORIZATION: import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    AUTHORIZATION: string;
+}, {
+    AUTHORIZATION: string;
+}>]>, import('zod').ZodUnion<[import('zod').ZodObject<{
+    'X-API-Token': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-API-Token': string;
+}, {
+    'X-API-Token': string;
+}>, import('zod').ZodObject<{
+    'X-Api-Token': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-Api-Token': string;
+}, {
+    'X-Api-Token': string;
+}>, import('zod').ZodObject<{
+    'x-api-token': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'x-api-token': string;
+}, {
+    'x-api-token': string;
+}>, import('zod').ZodObject<{
+    'X-API-TOKEN': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-API-TOKEN': string;
+}, {
+    'X-API-TOKEN': string;
+}>]>]>, import('zod').ZodUnion<[import('zod').ZodObject<{
+    'X-Lokalise-Plugin': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-Lokalise-Plugin': string;
+}, {
+    'X-Lokalise-Plugin': string;
+}>, import('zod').ZodObject<{
+    'x-lokalise-plugin': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'x-lokalise-plugin': string;
+}, {
+    'x-lokalise-plugin': string;
+}>, import('zod').ZodObject<{
+    'X-LOKALISE-PLUGIN': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-LOKALISE-PLUGIN': string;
+}, {
+    'X-LOKALISE-PLUGIN': string;
+}>]>>, false, false>;
+/**
+ * Public API router definition for updating project contributors
+ */
+export declare const updateContributors: import('@lokalise/api-contracts').PayloadRouteDefinition<{
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributorId: string;
+}, import('zod').ZodObject<{
+    is_admin: import('zod').ZodOptional<import('zod').ZodBoolean>;
+    is_reviewer: import('zod').ZodOptional<import('zod').ZodBoolean>;
+    role_id: import('zod').ZodOptional<import('zod').ZodNumber>;
+    admin_rights: import('zod').ZodOptional<import('zod').ZodArray<import('zod').ZodString, "many">>;
+    languages: import('zod').ZodArray<import('zod').ZodObject<{
+        lang_iso: import('zod').ZodString;
+        is_writable: import('zod').ZodOptional<import('zod').ZodBoolean>;
+    }, "strip", import('zod').ZodTypeAny, {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }, {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }>, "many">;
+}, "strip", import('zod').ZodTypeAny, {
+    languages: {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }[];
+    admin_rights?: string[] | undefined;
+    role_id?: number | undefined;
+    is_admin?: boolean | undefined;
+    is_reviewer?: boolean | undefined;
+}, {
+    languages: {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }[];
+    admin_rights?: string[] | undefined;
+    role_id?: number | undefined;
+    is_admin?: boolean | undefined;
+    is_reviewer?: boolean | undefined;
+}>, import('zod').ZodObject<{
+    project_id: import('zod').ZodString;
+    contributor: import('zod').ZodObject<{
+        user_id: import('zod').ZodNumber;
+        email: import('zod').ZodString;
+        fullname: import('zod').ZodString;
+        avatar_url: import('zod').ZodString;
+        created_at: import('zod').ZodString;
+        created_at_timestamp: import('zod').ZodNumber;
+        languages: import('zod').ZodArray<import('zod').ZodObject<{
+            lang_id: import('zod').ZodNumber;
+            lang_iso: import('zod').ZodString;
+            lang_name: import('zod').ZodString;
+            is_writable: import('zod').ZodUnion<[import('zod').ZodLiteral<0>, import('zod').ZodLiteral<1>, import('zod').ZodBoolean]>;
+        }, "strip", import('zod').ZodTypeAny, {
+            lang_id: number;
+            lang_iso: string;
+            lang_name: string;
+            is_writable: boolean | 0 | 1;
+        }, {
+            lang_id: number;
+            lang_iso: string;
+            lang_name: string;
+            is_writable: boolean | 0 | 1;
+        }>, "many">;
+        admin_rights: import('zod').ZodArray<import('zod').ZodString, "many">;
+        permissions: import('zod').ZodArray<import('zod').ZodString, "many">;
+        role_id: import('zod').ZodNullable<import('zod').ZodNumber>;
+        is_owner: import('zod').ZodBoolean;
+        is_admin: import('zod').ZodBoolean;
+        is_reviewer: import('zod').ZodBoolean;
+        is_pending: import('zod').ZodBoolean;
+        is_reinvited: import('zod').ZodBoolean;
+    }, "strip", import('zod').ZodTypeAny, {
+        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;
+    }, {
+        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;
+    }>;
+}, "strip", import('zod').ZodTypeAny, {
+    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;
+    };
+}, {
+    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;
+    };
+}>, import('zod').ZodObject<{
+    project: import('zod').ZodUnion<[import('zod').ZodObject<{
+        uuid: import('zod').ZodString;
+    }, "strip", import('zod').ZodTypeAny, {
+        uuid: string;
+    }, {
+        uuid: string;
+    }>, import('zod').ZodObject<{
+        id: import('zod').ZodString;
+    }, "strip", import('zod').ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>]>;
+    contributorId: import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributorId: string;
+}, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributorId: string;
+}>, undefined, import('zod').ZodIntersection<import('zod').ZodUnion<[import('zod').ZodUnion<[import('zod').ZodObject<{
+    authorization: import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    authorization: string;
+}, {
+    authorization: string;
+}>, import('zod').ZodObject<{
+    AUTHORIZATION: import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    AUTHORIZATION: string;
+}, {
+    AUTHORIZATION: string;
+}>]>, import('zod').ZodUnion<[import('zod').ZodObject<{
+    'X-API-Token': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-API-Token': string;
+}, {
+    'X-API-Token': string;
+}>, import('zod').ZodObject<{
+    'X-Api-Token': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-Api-Token': string;
+}, {
+    'X-Api-Token': string;
+}>, import('zod').ZodObject<{
+    'x-api-token': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'x-api-token': string;
+}, {
+    'x-api-token': string;
+}>, import('zod').ZodObject<{
+    'X-API-TOKEN': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-API-TOKEN': string;
+}, {
+    'X-API-TOKEN': string;
+}>]>]>, import('zod').ZodUnion<[import('zod').ZodObject<{
+    'X-Lokalise-Plugin': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-Lokalise-Plugin': string;
+}, {
+    'X-Lokalise-Plugin': string;
+}>, import('zod').ZodObject<{
+    'x-lokalise-plugin': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'x-lokalise-plugin': string;
+}, {
+    'x-lokalise-plugin': string;
+}>, import('zod').ZodObject<{
+    'X-LOKALISE-PLUGIN': import('zod').ZodString;
+}, "strip", import('zod').ZodTypeAny, {
+    'X-LOKALISE-PLUGIN': string;
+}, {
+    'X-LOKALISE-PLUGIN': string;
+}>]>>, false, false>;

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

@@ -0,0 +1,50 @@
+import { HeaderBuilder } from '../../auth/core/headers/headerBuilder';
+import { AddContributorsPathParams, AddContributorsRequestBody, AddContributorsResponse, ContributorApiBaseHeader } from '../types/contributorTypes';
+import { ApiMutationOverrides } from '../../../utils/types/apiMutationOverrides';
+import { Wretch } from 'wretch';
+/**
+ * A react-query wrapper about the addContributor public API endpoint
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param headers - Headers to include in the request.
+ * @param params - URL parameters
+ * @param overrides - Additional options to pass to the query.
+ */
+export declare function useAddContributorMutation<T>(wretchClient: Wretch<T>, headers: HeaderBuilder<ContributorApiBaseHeader>, params: AddContributorsPathParams, overrides?: ApiMutationOverrides<AddContributorsResponse, AddContributorsRequestBody>): import('@tanstack/react-query').UseMutationResult<{
+    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, {
+    contributors: {
+        email: string;
+        languages: {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }[];
+        fullname?: string | undefined;
+        admin_rights?: string[] | undefined;
+        role_id?: number | undefined;
+        is_admin?: boolean | undefined;
+        is_reviewer?: boolean | undefined;
+    }[];
+}, undefined>;

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

@@ -0,0 +1,46 @@
+import { HeaderBuilder } from '../../auth/core/headers/headerBuilder';
+import { ContributorApiBaseHeader, UpdateContributorsPathParams, UpdateContributorsRequestBody, UpdateContributorsResponse } from '../types/contributorTypes';
+import { ApiMutationOverrides } from '../../../utils/types/apiMutationOverrides';
+import { Wretch } from 'wretch';
+/**
+ * A react-query wrapper about the updateContributor public API endpoint
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param headers - Headers to include in the request.
+ * @param params - URL parameters
+ * @param overrides - Additional options to pass to the query.
+ */
+export declare function useUpdateContributorMutation<T>(wretchClient: Wretch<T>, headers: HeaderBuilder<ContributorApiBaseHeader>, params: UpdateContributorsPathParams, overrides?: ApiMutationOverrides<UpdateContributorsResponse, UpdateContributorsRequestBody>): import('@tanstack/react-query').UseMutationResult<{
+    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, {
+    languages: {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }[];
+    admin_rights?: string[] | undefined;
+    role_id?: number | undefined;
+    is_admin?: boolean | undefined;
+    is_reviewer?: boolean | undefined;
+}, undefined>;

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

@@ -6,6 +6,7 @@ export * from './score';
 export * from './team';
 export * from './teamUsers';
 export * from './userToken';
+export * from './hooks/useAddContributorsMutation';
 export * from './hooks/useAddLanguagesToProjectMutation';
 export * from './hooks/useBulkUpdateProjectLanguagesMutation';
 export * from './hooks/useCreateScoreMutation';
@@ -25,6 +26,7 @@ export * from './hooks/useListTeamUsersQuery';
 export * from './hooks/useRetrieveContributorQuery';
 export * from './hooks/useRetrieveProjectQuery';
 export * from './hooks/useRetrieveTeamQuery';
+export * from './hooks/useUpdateContributorMutation';
 export * from './hooks/useUpdateProjectMutation';
 export * from './types/contributorTypes';
 export * from './types/languageTypes';