@lokalise/harmony 1.34.3 → 1.36.0

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

@@ -0,0 +1,51 @@
+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<{
+    contributors: {
+        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;
+    project_uuid: string;
+}, 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/useDeleteContributorMutation.d.ts

@@ -0,0 +1,16 @@
+import { HeaderBuilder } from '../../auth/core/headers/headerBuilder';
+import { ContributorApiBaseHeader, DeleteContributorPathParams, DeleteContributorResponse } from '../types/contributorTypes';
+import { ApiMutationOverrides } from '../../../utils/types/apiMutationOverrides';
+import { Wretch } from 'wretch/types';
+/**
+ * A react-router wrapper about the deleteContributor public API endpoint
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param headers - Instance of the header builder for the public API.
+ * @param params - URL parameters
+ * @param overrides - Additional options to pass to the mutation.
+ */
+export declare const useDeleteContributorMutation: <T>(wretchClient: Wretch<T>, headers: HeaderBuilder<ContributorApiBaseHeader>, params: DeleteContributorPathParams, overrides: ApiMutationOverrides<DeleteContributorResponse, void>) => import('@tanstack/react-query').UseMutationResult<{
+    project_id: string;
+    contributor_deleted: boolean;
+}, undefined, void, 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,11 +6,13 @@ 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';
 export * from './hooks/useCreateProjectMutation';
 export * from './hooks/useDeleteScoreMutation';
+export * from './hooks/useDeleteContributorMutation';
 export * from './hooks/useDeleteProjectMutation';
 export * from './hooks/useGetProjectPermissionMetaQuery';
 export * from './hooks/useGetScoreQuery';
@@ -25,6 +27,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';

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

@@ -522,4 +522,484 @@ export declare const RETRIEVE_CONTRIBUTOR_RESPONSE_SCHEMA: z.ZodObject<{
     };
 }>;
 export type RetrieveContributorResponse = z.infer<typeof RETRIEVE_CONTRIBUTOR_RESPONSE_SCHEMA>;
+export declare const ADD_CONTRIBUTORS_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    project: z.ZodUnion<[z.ZodObject<{
+        uuid: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        uuid: string;
+    }, {
+        uuid: string;
+    }>, z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+}, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+}>;
+export type AddContributorsPathParams = z.infer<typeof ADD_CONTRIBUTORS_PATH_PARAMS_SCHEMA>;
+export declare const ADD_CONTRIBUTORS_REQUEST_BODY_SCHEMA: z.ZodObject<{
+    contributors: z.ZodArray<z.ZodObject<{
+        email: z.ZodString;
+        fullname: z.ZodOptional<z.ZodString>;
+        is_admin: z.ZodOptional<z.ZodBoolean>;
+        is_reviewer: z.ZodOptional<z.ZodBoolean>;
+        role_id: z.ZodOptional<z.ZodNumber>;
+        admin_rights: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        languages: z.ZodArray<z.ZodObject<{
+            lang_iso: z.ZodString;
+            is_writable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }, {
+            lang_iso: string;
+            is_writable?: boolean | undefined;
+        }>, "many">;
+    }, "strip", z.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", z.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;
+    }[];
+}>;
+export type AddContributorsRequestBody = z.infer<typeof ADD_CONTRIBUTORS_REQUEST_BODY_SCHEMA>;
+export declare const ADD_CONTRIBUTORS_RESPONSE_SCHEMA: z.ZodObject<{
+    project_id: z.ZodString;
+    project_uuid: z.ZodString;
+    contributors: z.ZodArray<z.ZodObject<{
+        user_id: z.ZodNumber;
+        email: z.ZodString;
+        fullname: z.ZodString;
+        avatar_url: z.ZodString;
+        created_at: z.ZodString;
+        created_at_timestamp: z.ZodNumber;
+        languages: z.ZodArray<z.ZodObject<{
+            lang_id: z.ZodNumber;
+            lang_iso: z.ZodString;
+            lang_name: z.ZodString;
+            is_writable: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodBoolean]>;
+        }, "strip", z.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: z.ZodArray<z.ZodString, "many">;
+        permissions: z.ZodArray<z.ZodString, "many">;
+        role_id: z.ZodNullable<z.ZodNumber>;
+        is_owner: z.ZodBoolean;
+        is_admin: z.ZodBoolean;
+        is_reviewer: z.ZodBoolean;
+        is_pending: z.ZodBoolean;
+        is_reinvited: z.ZodBoolean;
+    }, "strip", z.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;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    contributors: {
+        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;
+    project_uuid: string;
+}, {
+    contributors: {
+        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;
+    project_uuid: string;
+}>;
+export type AddContributorsResponse = z.infer<typeof ADD_CONTRIBUTORS_RESPONSE_SCHEMA>;
+export declare const UPDATE_CONTRIBUTORS_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    project: z.ZodUnion<[z.ZodObject<{
+        uuid: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        uuid: string;
+    }, {
+        uuid: string;
+    }>, z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>]>;
+    contributorId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributorId: string;
+}, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributorId: string;
+}>;
+export type UpdateContributorsPathParams = z.infer<typeof UPDATE_CONTRIBUTORS_PATH_PARAMS_SCHEMA>;
+export declare const UPDATE_CONTRIBUTORS_REQUEST_BODY_SCHEMA: z.ZodObject<{
+    is_admin: z.ZodOptional<z.ZodBoolean>;
+    is_reviewer: z.ZodOptional<z.ZodBoolean>;
+    role_id: z.ZodOptional<z.ZodNumber>;
+    admin_rights: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    languages: z.ZodArray<z.ZodObject<{
+        lang_iso: z.ZodString;
+        is_writable: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }, {
+        lang_iso: string;
+        is_writable?: boolean | undefined;
+    }>, "many">;
+}, "strip", z.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;
+}>;
+export type UpdateContributorsRequestBody = z.infer<typeof UPDATE_CONTRIBUTORS_REQUEST_BODY_SCHEMA>;
+export declare const UPDATE_CONTRIBUTORS_RESPONSE_SCHEMA: z.ZodObject<{
+    project_id: z.ZodString;
+    contributor: z.ZodObject<{
+        user_id: z.ZodNumber;
+        email: z.ZodString;
+        fullname: z.ZodString;
+        avatar_url: z.ZodString;
+        created_at: z.ZodString;
+        created_at_timestamp: z.ZodNumber;
+        languages: z.ZodArray<z.ZodObject<{
+            lang_id: z.ZodNumber;
+            lang_iso: z.ZodString;
+            lang_name: z.ZodString;
+            is_writable: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodBoolean]>;
+        }, "strip", z.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: z.ZodArray<z.ZodString, "many">;
+        permissions: z.ZodArray<z.ZodString, "many">;
+        role_id: z.ZodNullable<z.ZodNumber>;
+        is_owner: z.ZodBoolean;
+        is_admin: z.ZodBoolean;
+        is_reviewer: z.ZodBoolean;
+        is_pending: z.ZodBoolean;
+        is_reinvited: z.ZodBoolean;
+    }, "strip", z.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", z.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;
+    };
+}>;
+export type UpdateContributorsResponse = z.infer<typeof UPDATE_CONTRIBUTORS_RESPONSE_SCHEMA>;
+export declare const DELETE_CONTRIBUTOR_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    project: z.ZodUnion<[z.ZodObject<{
+        uuid: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        uuid: string;
+    }, {
+        uuid: string;
+    }>, z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>]>;
+    contributor: z.ZodUnion<[z.ZodObject<{
+        uuid: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        uuid: string;
+    }, {
+        uuid: string;
+    }>, z.ZodObject<{
+        id: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+    }, {
+        id: number;
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributor: {
+        id: number;
+    } | {
+        uuid: string;
+    };
+}, {
+    project: {
+        id: string;
+    } | {
+        uuid: string;
+    };
+    contributor: {
+        id: number;
+    } | {
+        uuid: string;
+    };
+}>;
+export type DeleteContributorPathParams = z.infer<typeof DELETE_CONTRIBUTOR_PATH_PARAMS_SCHEMA>;
+export declare const DELETE_CONTRIBUTOR_RESPONSE_SCHEMA: z.ZodObject<{
+    project_id: z.ZodString;
+    contributor_deleted: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    project_id: string;
+    contributor_deleted: boolean;
+}, {
+    project_id: string;
+    contributor_deleted: boolean;
+}>;
+export type DeleteContributorResponse = z.infer<typeof DELETE_CONTRIBUTOR_RESPONSE_SCHEMA>;
 export {};

package/package.json

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