@lokalise/harmony 1.10.0 → 1.11.1

package/dist/types/src/features/auth/frontend/middleware/promoteClassicSessionToJwtMiddleware.d.ts

@@ -0,0 +1,14 @@
+import { ConfiguredMiddleware, Wretch } from 'wretch';
+import { JwtAuthProps } from '../../core/middleware/jwtAuthMiddleware';
+export type PromoteAuthProps = JwtAuthProps & {
+    /**
+     * Team ID is required to issue a new JWT token.
+     */
+    getTeamId: () => Promise<number>;
+    /**
+     * The current CSRF token is required to issue a new JWT token.
+     * So this function should return the CSRF token for the current session.
+     */
+    getCsrfToken: () => Promise<string | undefined>;
+};
+export declare function promoteClassicSessionToJwtMiddleware<T>(client: Wretch<T>, props: PromoteAuthProps): ConfiguredMiddleware;

package/dist/types/src/features/auth/frontend/middleware/promoteClassicSessionToJwtMiddleware.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/features/auth/frontend/utils/cookieTokenUtils.d.ts

@@ -0,0 +1,4 @@
+import { JwtToken } from '../../../publicApi/types/userTokenTypes';
+export declare function getJwtTokenFromCookie(): JwtToken | undefined;
+export declare function getCsrfTokenFromCookie(): string | undefined;
+export declare function getCookie(cookies: string, name: string): string | undefined;

package/dist/types/src/features/auth/frontend/utils/cookieTokenUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,9 @@
+export * from './frontend/hooks/useGetPromotedClassicSessionJwtQuery';
+export * from './frontend/hooks/useAuthenticatedSessionPayload';
+export * from './frontend/hooks/useAuthenticatedUser';
+export * from './frontend/hooks/useAuthenticatedProjectContributor';
+export * from './backend/services/getAuthenticatedSessionDetailFromRequest';
+export { parseJwtTokenPayload } from './core/jwtTokenPayload';
+export { publicApiHeadersMiddleware } from './core/middleware/publicApiHeadersMiddleware';
+export { LokaliseAuthAddon } from './core/lokaliseAuthAddon';
+export { LokaliseAuthBrowserAddon } from './frontend/addon/lokaliseAuthBrowserAddon';

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

@@ -0,0 +1,2 @@
+export * from './auth/node';
+export * from './publicApi/node';

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

@@ -0,0 +1,111 @@
+import { z } from 'zod';
+/**
+ * Public API router definition for retrieving a project contributor
+ */
+export declare const retrieveContributor: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
+    projectId: string;
+    contributorId: number;
+}, 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;
+}>, z.ZodObject<{
+    projectId: z.ZodString;
+    contributorId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    projectId: string;
+    contributorId: number;
+}, {
+    projectId: string;
+    contributorId: number;
+}>, undefined, undefined, false, false>;

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

@@ -0,0 +1,76 @@
+import { ApiMutationOverrides } from '../../../utils/types/apiMutationOverrides';
+import { Wretch } from 'wretch';
+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;
+    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, {
+    name: string;
+    team_id: string;
+    languages: {
+        lang_iso: string;
+        custom_iso?: string | undefined;
+    }[];
+    project_type: "localization_files" | "paged_documents" | "marketing";
+    base_lang_iso: string;
+    is_segmentation_enabled: boolean;
+}, undefined>;

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

@@ -0,0 +1,26 @@
+import { TeamUserResponse } from '../types/teamUserTypes';
+import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
+import { Wretch } from 'wretch/types';
+/**
+ * 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];
+};
+/**
+ * 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";
+        email: string;
+        user_id: number;
+        fullname: string;
+        created_at: string;
+        created_at_timestamp: number;
+    };
+}, undefined>;

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

@@ -0,0 +1,20 @@
+import { JwtToken } from '../types/userTokenTypes';
+import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
+import { Wretch } from 'wretch/types';
+/**
+ * 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];
+};
+/**
+ * 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

@@ -0,0 +1,81 @@
+import { ListProjectsRequestQuery, ListProjectsSuccessResponseBody } from '../types/projectTypes';
+import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
+import { Wretch } from 'wretch';
+/**
+ * Factory for the listProjects public API endpoint key
+ */
+export declare const listProjectsKey: {
+    paramsKey: (params: ListProjectsRequestQuery) => readonly ["listProjects", {
+        page?: number | undefined;
+        project_type?: "localization_files" | "paged_documents" | "marketing" | undefined;
+        filter_team_id?: number | undefined;
+        filter_names?: string | undefined;
+        include_statistics?: boolean | undefined;
+        include_settings?: boolean | undefined;
+        limit?: number | undefined;
+    }];
+};
+/**
+ * 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;
+    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>;

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';