@lokalise/harmony 1.6.0-exp-jwtutils.22 → 1.8.0

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

@@ -1,100 +1,7 @@
 import { z } from 'zod';
-declare const RETRIEVE_CONTRIBUTORS_RESPONSE_SCHEMA: z.ZodObject<{
-    project_id: z.ZodString;
-    contributors: z.ZodArray<z.ZodObject<{
-        user_id: z.ZodNumber;
-        email: z.ZodString;
-        fullname: z.ZodString;
-        created_at: z.ZodString;
-        created_at_timestamp: z.ZodNumber;
-        admin_rights: z.ZodArray<z.ZodString, "many">;
-        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>]>;
-        }, "strip", z.ZodTypeAny, {
-            lang_id: number;
-            lang_iso: string;
-            lang_name: string;
-            is_writable: 0 | 1;
-        }, {
-            lang_id: number;
-            lang_iso: string;
-            lang_name: string;
-            is_writable: 0 | 1;
-        }>, "many">;
-        is_admin: z.ZodBoolean;
-        is_reviewer: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        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;
-    }, {
-        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;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    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;
-}, {
-    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;
-}>;
-export type RetrieveContributorsResponse = z.infer<typeof RETRIEVE_CONTRIBUTORS_RESPONSE_SCHEMA>;
+/**
+ * Public API router definition for retrieving a project contributor
+ */
 export declare const retrieveContributor: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
     projectId: string;
     contributorId: number;
@@ -202,4 +109,3 @@ export declare const retrieveContributor: import('@lokalise/universal-ts-utils/n
     projectId: string;
     contributorId: number;
 }>, undefined, undefined, false, false>;
-export {};

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

@@ -1,18 +1,23 @@
 import { ApiMutationOverrides } from '../../../utils/types/apiMutationOverrides';
 import { Wretch } from 'wretch';
-import { CreateProjectRequestBody } from '../projects';
-import { Project } from '../types/project';
-export declare function useCreateProjectMutation<T>(api: Wretch<T>, overrides?: ApiMutationOverrides<Project, CreateProjectRequestBody>): import('@tanstack/react-query').UseMutationResult<{
+import { CreateProjectRequestBody, Project } from '../types/projectTypes';
+/**
+ * A react-router wrapper about the createProject 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 useCreateProjectMutation<T>(wretchClient: Wretch<T>, overrides?: ApiMutationOverrides<Project, CreateProjectRequestBody>): import('@tanstack/react-query').UseMutationResult<{
     name: string;
     created_at: string;
     created_at_timestamp: number;
-    project_id: string;
+    team_id: number;
     description: string;
+    project_id: string;
     uuid: string;
     project_type: "localization_files" | "paged_documents" | "marketing";
     created_by: number;
     created_by_email: string;
-    team_id: number;
     base_language_id: number;
     base_language_iso: string;
     settings: {
@@ -60,12 +65,12 @@ export declare function useCreateProjectMutation<T>(api: Wretch<T>, overrides?:
     };
 }, undefined, {
     name: string;
+    team_id: string;
     languages: {
         lang_iso: string;
         custom_iso?: string | undefined;
     }[];
     project_type: "localization_files" | "paged_documents" | "marketing";
-    team_id: string;
     base_lang_iso: string;
     is_segmentation_enabled: boolean;
 }, undefined>;

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

@@ -1,10 +1,19 @@
+import { TeamUserResponse } from '../types/teamUserTypes';
 import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
 import { Wretch } from 'wretch/types';
-import { TeamUserResponse } from '../teamUsers';
+/**
+ * Factory for generating the query key for the getTeamUser public API endpoint
+ */
 export declare const getTeamUsersQueryKey: {
     teamUserKey: (teamId: number, userId: number) => readonly ["GetTeamUsers", number, number];
 };
-export declare const useGetTeamUsersQuery: <T>(api: Wretch<T>, overrides: ApiQueryOverrides<TeamUserResponse, typeof getTeamUsersQueryKey>) => import('@tanstack/react-query').UseQueryResult<{
+/**
+ * A react-router wrapper about the getTeamUser 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 useGetTeamUsersQuery: <T>(wretchClient: Wretch<T>, overrides: ApiQueryOverrides<TeamUserResponse, typeof getTeamUsersQueryKey>) => import('@tanstack/react-query').UseQueryResult<{
     team_id: number;
     team_user: {
         role: "member" | "admin" | "biller" | "owner";

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

@@ -1,11 +1,20 @@
+import { JwtToken } from '../types/userTokenTypes';
 import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
 import { Wretch } from 'wretch/types';
-import { JwtToken } from '../userToken';
+/**
+ * Factory for generating keys for the getUserToken public API endpoint
+ */
 export declare const getUserTokenKey: {
     teamKeyCsrf: (teamId: number, csrf: string) => readonly ["getUserToken", "x-csrf-token", string, number];
     teamKeyJwt: (teamId: number, refreshToken: string) => readonly ["getUserToken", "Authorization", `Bearer ${string}`, number];
 };
-export declare const useGetUserTokenQuery: <T>(api: Wretch<T>, overrides: ApiQueryOverrides<JwtToken, typeof getUserTokenKey>) => import('@tanstack/react-query').UseQueryResult<{
+/**
+ * A react-router wrapper about the getUserToken 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 useGetUserTokenQuery: <T>(wretchClient: Wretch<T>, overrides: ApiQueryOverrides<JwtToken, typeof getUserTokenKey>) => import('@tanstack/react-query').UseQueryResult<{
     accessToken: string;
     refreshToken: string;
 }, undefined>;

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

@@ -1,6 +1,9 @@
+import { ListProjectsRequestQuery, ListProjectsSuccessResponseBody } from '../types/projectTypes';
 import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
 import { Wretch } from 'wretch';
-import { ListProjectsRequestQuery, ListProjectsSuccessResponseBody } from '../projects';
+/**
+ * Factory for the listProjects public API endpoint key
+ */
 export declare const listProjectsKey: {
     paramsKey: (params: ListProjectsRequestQuery) => readonly ["listProjects", {
         page?: number | undefined;
@@ -12,17 +15,23 @@ export declare const listProjectsKey: {
         limit?: number | undefined;
     }];
 };
-export declare function useListProjectsQuery<T>(api: Wretch<T>, overrides: ApiQueryOverrides<ListProjectsSuccessResponseBody, typeof listProjectsKey>): import('@tanstack/react-query').UseQueryResult<({
+/**
+ * A react-router wrapper about the listProjects 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 useListProjectsQuery<T>(wretchClient: Wretch<T>, overrides: ApiQueryOverrides<ListProjectsSuccessResponseBody, typeof listProjectsKey>): import('@tanstack/react-query').UseQueryResult<({
     name: string;
     created_at: string;
     created_at_timestamp: number;
-    project_id: string;
+    team_id: number;
     description: string;
+    project_id: string;
     uuid: string;
     project_type: "localization_files" | "paged_documents" | "marketing";
     created_by: number;
     created_by_email: string;
-    team_id: number;
     base_language_id: number;
     base_language_iso: string;
 } | {

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

@@ -1,10 +1,19 @@
+import { RetrieveContributorsResponse } from '../types/contributorTypes';
 import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
 import { Wretch } from 'wretch';
-import { RetrieveContributorsResponse } from '../contributors';
+/**
+ * Factory for creating keys for the useRetrieveContributorQuery hook
+ */
 export declare const retrieveContributorKeys: {
     projectUserKey: (projectId: string, userId: number) => readonly ["RetrieveContributor", string, number];
 };
-export declare const useRetrieveContributorQuery: <T>(api: Wretch<T>, overrides: ApiQueryOverrides<RetrieveContributorsResponse, typeof retrieveContributorKeys>) => import('@tanstack/react-query').UseQueryResult<{
+/**
+ * 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;

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

@@ -1,20 +1,29 @@
 import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
 import { Wretch } from 'wretch';
-import { Project } from '../types/project';
+import { Project } from '../types/projectTypes';
+/**
+ * Factory function to create the query key for the retrieveProject query
+ */
 export declare const retrieveProjectQueryKey: {
     projectIdKey: (projectId: string) => string[];
 };
-export declare function useRetrieveProjectQuery<T>(api: Wretch<T>, overrides: ApiQueryOverrides<Project, typeof retrieveProjectQueryKey>): import('@tanstack/react-query').UseQueryResult<{
+/**
+ * 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;
-    project_id: string;
+    team_id: number;
     description: string;
+    project_id: string;
     uuid: string;
     project_type: "localization_files" | "paged_documents" | "marketing";
     created_by: number;
     created_by_email: string;
-    team_id: number;
     base_language_id: number;
     base_language_iso: string;
     settings: {

package/dist/types/src/features/publicApi/{index.d.ts → node.d.ts}

@@ -2,9 +2,12 @@ export * from './contributors';
 export * from './projects';
 export * from './teamUsers';
 export * from './userToken';
-export type { LanguageStatistics, LanguageIso } from './types/language';
-export type { Project, ProjectQaIssues, ProjectType, ProjectSettings } from './types/project';
-export type { TeamRole } from './types/teamRole';
+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';