@lokalise/harmony 1.6.0 → 1.8.0

package/dist/types/src/components/Sidebar/Sidebar.d.ts

@@ -2,10 +2,13 @@ import { HTMLProps, PropsWithChildren, ReactNode } from 'react';
 type SidebarProps = HTMLProps<HTMLElement> & {
     children: ReactNode;
 };
+/**
+ * Sidebar is a self-contained component using widgets.
+ */
 declare const Sidebar: {
     ({ children, ...navProps }: SidebarProps): import("react/jsx-runtime").JSX.Element;
-    Top({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element;
-    Bottom({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element;
+    Top: ({ children }: PropsWithChildren) => import("react/jsx-runtime").JSX.Element;
+    Bottom: ({ children }: PropsWithChildren) => import("react/jsx-runtime").JSX.Element;
     Avatar: ({ src, href, ariaLabel, alt }: {
         src: string;
         href?: string;

package/dist/types/src/components/Sidebar/Widgets/Avatar/Avatar.d.ts

@@ -4,5 +4,8 @@ type AvatarProps = {
     ariaLabel?: string;
     alt?: string;
 };
+/**
+ * Display company main avatar / logo in the top section
+ */
 export declare const Avatar: ({ src, href, ariaLabel, alt }: AvatarProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/src/components/Sidebar/Widgets/IconLink/IconLink.d.ts

@@ -5,5 +5,8 @@ type IconLinkProps = {
     label: string;
     icon: FC<SvgIconProps>;
 };
+/**
+ * Display link with an icon. Mainly used in the top section
+ */
 export declare const IconLink: ({ label, to, icon: Icon }: IconLinkProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/src/components/Sidebar/Widgets/Menu/Menu.d.ts

@@ -3,5 +3,8 @@ import { FC, PropsWithChildren } from 'react';
 type MenuProps = PropsWithChildren<{
     icon: FC<SvgIconProps>;
 }>;
+/**
+ * Use this widget for simple side menu. Currently utilised for `Help` section
+ */
 export declare const Menu: ({ children, icon: Icon }: MenuProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/src/components/Sidebar/Widgets/ProfileMenu/ProfileMenu.d.ts

@@ -4,5 +4,9 @@ type ProfileMenuProps = {
     config: SidebarProfileMenuConfig;
     children: ProfileMenuContentProps['children'];
 };
+/**
+ * Contextual component, requires initial configuration
+ * and works with internal widgets
+ */
 export declare const ProfileMenu: ({ config, children }: ProfileMenuProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/src/components/Sidebar/Widgets/ProfileMenu/ProfileSettingsMenuItem/ProfileSettingsMenuItem.d.ts

@@ -4,5 +4,9 @@ type ProfileSettingsMenuItemProps = {
     onClick?: () => void;
     hideBottomDivider?: boolean;
 };
+/**
+ * Menu item that comes with a small user's email and renders conditionally,
+ * only if team is not suspended or is not at the end of a trial
+ */
 export declare const ProfileSettingsMenuItem: ({ href, onClick, userEmail, hideBottomDivider, }: ProfileSettingsMenuItemProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/types/src/components/Sidebar/Widgets/ProfileMenu/TeamMenuItem/TeamMenuItem.d.ts

@@ -4,5 +4,10 @@ type TeamMenuItemProps = {
     onClick?: (team: SidebarTeam) => void;
     hidePlanLabel?: boolean;
 };
+/**
+ * Uses context of current team, and depending on ability to switch team or not,
+ * it renders as a div or clickable MenuItem. If used with TeamSwitch, it triggers `onSwitchTeams`
+ * callback, passing relevant team as an argument
+ */
 export declare const TeamMenuItem: ({ team, onClick, hidePlanLabel }: TeamMenuItemProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/types/src/components/Sidebar/Widgets/ProfileMenu/TeamSwitch/TeamSwitch.d.ts

@@ -2,5 +2,8 @@ import { SidebarTeam } from '../../../types';
 type TeamSwitchProps = {
     onSwitchTeam: (team: SidebarTeam) => void;
 };
+/**
+ * Uses available teams (other than current) and allows user to switch between them
+ */
 export declare const TeamSwitch: ({ onSwitchTeam }: TeamSwitchProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/types/src/components/Sidebar/Widgets/ProfileMenu/UpgradeMenuItem/UpgradeMenuItem.d.ts

@@ -1,5 +1,10 @@
 type UpgradeMenuItemProps = {
     upgradeOptionHref: string;
 };
+/**
+ * Menu item conditionally rendering only if `showUpgradeButton` is `true`.
+ * It renders correct upgrade note depending on the current team plan
+ * and red arrow up to indicate an update option.
+ */
 export declare const UpgradeMenuItem: ({ upgradeOptionHref }: UpgradeMenuItemProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/types/src/components/Sidebar/Widgets/ProfileMenu/types.d.ts

@@ -1,4 +1,5 @@
 import { SidebarTeam, SidebarTeamRole } from '../../types';
+export type { SidebarTeam, SidebarTeamRole } from '../../types';
 export type SidebarProfileMenuConfig = {
     teams: SidebarTeam[];
     isTeamSuspended: boolean;

package/dist/types/src/features/auth/backend/services/getAuthenticatedSessionDetailFromRequest.d.ts

@@ -0,0 +1,10 @@
+import { JwtTokenPayload } from '../../core/types/jwtTokenPayload';
+import { JwtToken } from '../../../publicApi/types/userTokenTypes';
+type AuthenticatedSessionDetail = JwtToken & {
+    payload: JwtTokenPayload;
+};
+/**
+ * Returns the JWT tokens and parses the attached payload.
+ */
+export declare function getAuthenticatedSessionDetailFromRequest(): AuthenticatedSessionDetail | undefined;
+export {};

package/dist/types/src/features/auth/backend/services/getAuthenticatedSessionPayloadFromRequest.test.d.ts

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

package/dist/types/src/features/auth/core/jwtTokenPayload.d.ts

@@ -0,0 +1,7 @@
+import { JwtTokenPayload } from './types/jwtTokenPayload';
+/**
+ * Parses the payload of a JWT token.
+ *
+ * @param token - The JWT token to parse.
+ */
+export declare function parseJwtTokenPayload(token: string): JwtTokenPayload | undefined;

package/dist/types/src/features/auth/core/jwtTokenPayload.test.d.ts

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

package/dist/types/src/features/auth/core/lokaliseAuthAddon.d.ts

@@ -0,0 +1,14 @@
+import { Wretch, WretchAddon } from 'wretch/types';
+import { JwtAuthProps } from './middleware/jwtAuthMiddleware';
+export interface LokaliseAuthAddon {
+    /**
+     * Add authentication and automatic token refresh to Lokalise requests.
+     */
+    lokaliseAuth<T extends LokaliseAuthAddon>(this: T & Wretch<T>, props: JwtAuthProps): this;
+}
+/**
+ * Addon for Lokalise authentication.
+ * This will expose a method that can be used to authenticate requests to Lokalise.
+ * It will also handle refreshing the token when it expires.
+ */
+export declare const LokaliseAuthAddon: WretchAddon<LokaliseAuthAddon>;

package/dist/types/src/features/auth/core/middleware/jwtAuthMiddleware.d.ts

@@ -0,0 +1,13 @@
+import { JwtToken } from '../../../publicApi/types/userTokenTypes';
+import { ConfiguredMiddleware, Wretch } from 'wretch';
+export type JwtAuthProps = {
+    /**
+     * This function should return the current JWT token if it exists.
+     */
+    getCachedJwtToken: () => Promise<JwtToken | undefined>;
+    /**
+     * This function is called when a new JWT token is issued or if/when the token is refreshed.
+     */
+    onNewJwtTokenIssued?: (jwtToken: JwtToken) => Promise<void>;
+};
+export declare function jwtAuthMiddleware<T>(client: Wretch<T>, props: JwtAuthProps): ConfiguredMiddleware;

package/dist/types/src/features/auth/core/middleware/jwtAuthMiddleware.test.d.ts

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

package/dist/types/src/features/auth/core/middleware/publicApiHeadersMiddleware.d.ts

@@ -0,0 +1,5 @@
+import { ConfiguredMiddleware } from 'wretch';
+/**
+ * Adds the required headers to make requests to the public API.
+ */
+export declare function publicApiHeadersMiddleware(): ConfiguredMiddleware;

package/dist/types/src/features/auth/core/types/jwtTokenPayload.d.ts

@@ -0,0 +1,42 @@
+import { z } from 'zod';
+export declare const JWT_TOKEN_PAYLOAD_SCHEMA: z.ZodObject<{
+    userId: z.ZodNumber;
+    userUuid: z.ZodString;
+    teamId: z.ZodNumber;
+    userTeamRole: z.ZodUnion<[z.ZodLiteral<"owner">, z.ZodLiteral<"admin">, z.ZodLiteral<"biller">, z.ZodLiteral<"member">]>;
+    userEmail: z.ZodString;
+    userName: z.ZodString;
+    userCurrentTeamId: z.ZodNumber;
+    planId: z.ZodNumber;
+    planName: z.ZodString;
+    isProviderAlpha: z.ZodBoolean;
+    isFullyAuthenticated: z.ZodBoolean;
+    exp: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    isProviderAlpha: boolean;
+    isFullyAuthenticated: boolean;
+    planId: number;
+    userTeamRole: "member" | "admin" | "biller" | "owner";
+    userEmail: string;
+    teamId: number;
+    userId: number;
+    userUuid: string;
+    userName: string;
+    userCurrentTeamId: number;
+    planName: string;
+    exp: number;
+}, {
+    isProviderAlpha: boolean;
+    isFullyAuthenticated: boolean;
+    planId: number;
+    userTeamRole: "member" | "admin" | "biller" | "owner";
+    userEmail: string;
+    teamId: number;
+    userId: number;
+    userUuid: string;
+    userName: string;
+    userCurrentTeamId: number;
+    planName: string;
+    exp: number;
+}>;
+export type JwtTokenPayload = z.infer<typeof JWT_TOKEN_PAYLOAD_SCHEMA>;

package/dist/types/src/features/auth/core/types/jwtTokenPayload.fixture.d.ts

@@ -0,0 +1,27 @@
+export declare const createMockJwtTokenPayload: (overrides?: {
+    isProviderAlpha?: boolean | undefined;
+    isFullyAuthenticated?: boolean | undefined;
+    planId?: number | undefined;
+    userTeamRole?: "member" | "admin" | "biller" | "owner" | undefined;
+    userEmail?: string | undefined;
+    teamId?: number | undefined;
+    userId?: number | undefined;
+    userUuid?: string | undefined;
+    userName?: string | undefined;
+    userCurrentTeamId?: number | undefined;
+    planName?: string | undefined;
+    exp?: number | undefined;
+} | undefined, removeProperties?: ("isProviderAlpha" | "isFullyAuthenticated" | "planId" | "userTeamRole" | "userEmail" | "teamId" | "userId" | "userUuid" | "userName" | "userCurrentTeamId" | "planName" | "exp")[]) => {
+    isProviderAlpha: boolean;
+    isFullyAuthenticated: boolean;
+    planId: number;
+    userTeamRole: "member" | "admin" | "biller" | "owner";
+    userEmail: string;
+    teamId: number;
+    userId: number;
+    userUuid: string;
+    userName: string;
+    userCurrentTeamId: number;
+    planName: string;
+    exp: number;
+};

package/dist/types/src/features/auth/core/utils/makeAuthHeader.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticatedRequestHeader } from '../../../publicApi/types/userTokenTypes';
+export declare function makeAuthHeader(token: string): AuthenticatedRequestHeader;

package/dist/types/src/features/auth/core/utils/makeAuthHeader.test.d.ts

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

package/dist/types/src/features/auth/frontend/addon/lokaliseAuthBrowserAddon.d.ts

@@ -0,0 +1,35 @@
+import { Wretch, WretchAddon } from 'wretch/types';
+import { JwtAuthProps } from '../../core/middleware/jwtAuthMiddleware';
+import { PromoteAuthProps } from '../middleware/promoteClassicSessionToJwtMiddleware';
+type BrowserJwtAuthProps = Omit<JwtAuthProps, 'getCachedJwtToken'> & {
+    /**
+     * The browser implementation makes this optional, as it can be inferred from the cookie.
+     * You can still provide a custom implementation if you want to.
+     */
+    getCachedJwtToken?: JwtAuthProps['getCachedJwtToken'];
+};
+type BrowserPromoteAuthProps = Omit<PromoteAuthProps, 'getCachedJwtToken' | 'getCsrfToken'> & {
+    /**
+     * The browser implementation makes this optional, as it can be inferred from the cookie.
+     * You can still provide a custom implementation if you want to.
+     */
+    getCachedJwtToken?: PromoteAuthProps['getCachedJwtToken'];
+    /**
+     * The browser implementation makes this optional, as it can be inferred from the cookie.
+     * You can still provide a custom implementation if you want to.
+     */
+    getCsrfToken?: PromoteAuthProps['getCsrfToken'];
+};
+export interface LokaliseAuthBrowserAddon {
+    lokaliseAuth<T extends LokaliseAuthBrowserAddon>(this: T & Wretch<T>, props?: BrowserJwtAuthProps): this;
+    promoteClassicSession<T extends LokaliseAuthBrowserAddon>(this: T & Wretch<T>, props: BrowserPromoteAuthProps): this;
+}
+/**
+ * A browser implementation of the LokaliseAuthAddon.
+ * This implementation provides default providers that uses cookies to retrieve the JWT token.
+ *
+ * It exposes another utility method to automatically promote a classic session to a JWT session
+ * when a request is made from an environment using class CSRF PHP token authentication.
+ */
+export declare const LokaliseAuthBrowserAddon: WretchAddon<LokaliseAuthBrowserAddon>;
+export {};

package/dist/types/src/features/auth/frontend/events/NewJwtIssuedEvent.d.ts

@@ -0,0 +1,20 @@
+import { JwtTokenPayload } from '../../core/types/jwtTokenPayload';
+import { JwtToken } from '../../../publicApi/types/userTokenTypes';
+type NewJwtIssuedEventDetail = {
+    token: JwtToken;
+    payload: JwtTokenPayload | undefined;
+};
+/**
+ * This event is emitted when a new JWT token is issued or refreshed.
+ */
+export declare class NewJwtIssuedEvent extends CustomEvent<NewJwtIssuedEventDetail> {
+    static readonly eventName: "new-jwt-issued";
+    constructor(token: JwtToken);
+}
+export declare const isNewJwtIssuedEvent: (event: Event) => event is NewJwtIssuedEvent;
+declare global {
+    interface WindowEventMap {
+        [NewJwtIssuedEvent.eventName]: NewJwtIssuedEvent;
+    }
+}
+export {};

package/dist/types/src/features/auth/frontend/hooks/useAuthenticatedProjectContributor.d.ts

@@ -0,0 +1,28 @@
+import { Wretch } from 'wretch';
+/**
+ * Uses the payload attached to the JWT to request the contributor information
+ * of the provided project for the authenticated user.
+ * This required an active JWT token to be present in the cookie.
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param projectId - The ID of the project to retrieve the contributor information.
+ */
+export declare function useAuthenticatedProjectContributor<T>(wretchClient: Wretch<T>, projectId: string): 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/auth/frontend/hooks/useAuthenticatedSessionPayload.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A hook that will bring the cached JWT token into the React lifecycle.
+ * If the token is updated or removed, the hook will update the state.
+ */
+export declare function useAuthenticatedSessionPayload(): {
+    isProviderAlpha: boolean;
+    isFullyAuthenticated: boolean;
+    planId: number;
+    userTeamRole: "member" | "admin" | "biller" | "owner";
+    userEmail: string;
+    teamId: number;
+    userId: number;
+    userUuid: string;
+    userName: string;
+    userCurrentTeamId: number;
+    planName: string;
+    exp: number;
+} | undefined;

package/dist/types/src/features/auth/frontend/hooks/useAuthenticatedUser.d.ts

@@ -0,0 +1,18 @@
+import { Wretch } from 'wretch';
+/**
+ * Uses the payload attached to the JWT to request the team-user information for the authenticated user.
+ * This required an active JWT token to be present in the cookie.
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ */
+export declare function useAuthenticatedUser<T>(wretchClient: Wretch<T>): 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/auth/frontend/hooks/useGetPromotedClassicSessionJwtQuery.d.ts

@@ -0,0 +1,12 @@
+import { Wretch } from 'wretch';
+/**
+ * For use in environments that are authenticated with a classic CSRF PHP session (e.g. Expert).
+ * This hook will send that token to the public API, upgrade to a JWT session.
+ *
+ * @param wretchClient - Wretch instance configured to a public API instance.
+ * @param teamId - The team ID to get the JWT for.
+ */
+export declare function useGetPromotedClassicSessionJwtQuery<T>(wretchClient: Wretch<T>, teamId: number): import('@tanstack/react-query').UseQueryResult<{
+    accessToken: string;
+    refreshToken: string;
+}, undefined>;

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