@lokalise/harmony 1.22.1 → 1.23.0

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

@@ -1,7 +1,7 @@
 /**
  * Public API router definition for retrieving a project contributor
  */
-export declare const retrieveContributor: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
+export declare const retrieveContributor: import('@lokalise/api-contracts').GetRouteDefinition<{
     project: {
         uuid: string;
     } | {

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

@@ -0,0 +1,21 @@
+import { HeaderBuilder } from '../../node';
+import { ApiQueryOverrides } from '../../../utils/types/apiQueryOverrides';
+import { Wretch } from 'wretch';
+import { GetScoreRequestQuery, GetScoreResponseBody } from '../types/scoreTypes';
+import { BaseApiEndpointHeader } from '../types/sharedTypes';
+export declare const getScoreKey: {
+    paramsKey: (params: GetScoreRequestQuery) => readonly ["getScore", {
+        projectId: string;
+        translationId: number;
+    }];
+};
+export declare function useGetScoreQuery<T>(wretchClient: Wretch<T>, headers: HeaderBuilder<BaseApiEndpointHeader>, overrides: ApiQueryOverrides<GetScoreResponseBody, typeof getScoreKey>): import('@tanstack/react-query').UseQueryResult<{
+    issues: {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }[];
+    score: number;
+    hasMajorIssue: boolean;
+    hasCriticalIssue: boolean;
+}, undefined>;

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

@@ -1,4 +1,4 @@
-export declare const listProjectLanguages: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
+export declare const listProjectLanguages: import('@lokalise/api-contracts').GetRouteDefinition<{
     projectId: string;
 }, import('zod').ZodObject<{
     project_id: import('zod').ZodString;
@@ -113,7 +113,7 @@ export declare const listProjectLanguages: import('@lokalise/universal-ts-utils/
 }, {
     'X-LOKALISE-PLUGIN': string;
 }>]>>, false, false>;
-export declare const addLanguagesToProject: import('@lokalise/universal-ts-utils/node').PayloadRouteDefinition<{
+export declare const addLanguagesToProject: import('@lokalise/api-contracts').PayloadRouteDefinition<{
     projectId: string;
 }, import('zod').ZodObject<{
     languages: import('zod').ZodArray<import('zod').ZodObject<{
@@ -282,7 +282,7 @@ export declare const addLanguagesToProject: import('@lokalise/universal-ts-utils
 }, {
     'X-LOKALISE-PLUGIN': string;
 }>]>>, false, false>;
-export declare const bulkUpdateProjectLanguages: import('@lokalise/universal-ts-utils/node').PayloadRouteDefinition<{
+export declare const bulkUpdateProjectLanguages: import('@lokalise/api-contracts').PayloadRouteDefinition<{
     projectId: string;
 }, import('zod').ZodObject<{
     langs: import('zod').ZodArray<import('zod').ZodObject<{

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

@@ -9,6 +9,7 @@ export * from './types/teamRoleTypes';
 export * from './types/contributorTypes';
 export * from './types/teamUserTypes';
 export * from './types/userTokenTypes';
+export * from './types/scoreTypes';
 export * from './hooks/useCreateProjectMutation';
 export * from './hooks/useGetTeamUsersQuery';
 export * from './hooks/useGetUserTokenQuery';
@@ -18,3 +19,4 @@ export * from './hooks/useRetrieveContributorQuery';
 export * from './hooks/useRetrieveProjectQuery';
 export * from './hooks/useUpdateProjectMutation';
 export * from './hooks/useBulkUpdateProjectLanguagesMutation';
+export * from './hooks/useGetScoreQuery';

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

@@ -1,7 +1,7 @@
 /**
  * Public API router definition for creating a new project
  */
-export declare const createProject: import('@lokalise/universal-ts-utils/node').PayloadRouteDefinition<never, import('zod').ZodObject<{
+export declare const createProject: import('@lokalise/api-contracts').PayloadRouteDefinition<never, import('zod').ZodObject<{
     name: import('zod').ZodString;
     team_id: import('zod').ZodString;
     base_lang_iso: import('zod').ZodString;
@@ -412,7 +412,7 @@ export declare const createProject: import('@lokalise/universal-ts-utils/node').
 /**
  * Public API router definition for listing all projects
  */
-export declare const listProjects: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<never, import('zod').ZodObject<{
+export declare const listProjects: import('@lokalise/api-contracts').GetRouteDefinition<never, import('zod').ZodObject<{
     projects: import('zod').ZodArray<import('zod').ZodObject<{
         project_id: import('zod').ZodString;
         uuid: import('zod').ZodString;
@@ -939,7 +939,7 @@ export declare const listProjects: import('@lokalise/universal-ts-utils/node').G
 /**
  * Public API router definition for retrieving a project
  */
-export declare const retrieveProject: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
+export declare const retrieveProject: import('@lokalise/api-contracts').GetRouteDefinition<{
     project_id: string;
 }, import('zod').ZodObject<{
     project_id: import('zod').ZodString;
@@ -1322,7 +1322,7 @@ export declare const retrieveProject: import('@lokalise/universal-ts-utils/node'
 /**
  * Public API router definition for updating a project
  */
-export declare const updateProject: import('@lokalise/universal-ts-utils/node').PayloadRouteDefinition<{
+export declare const updateProject: import('@lokalise/api-contracts').PayloadRouteDefinition<{
     project_id: string;
 }, import('zod').ZodObject<{
     name: import('zod').ZodString;

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

@@ -0,0 +1,102 @@
+export declare const getScore: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
+    projectId: string;
+    translationId: number;
+}, import('zod').ZodObject<{
+    score: import('zod').ZodNumber;
+    hasMajorIssue: import('zod').ZodBoolean;
+    hasCriticalIssue: import('zod').ZodBoolean;
+    issues: import('zod').ZodArray<import('zod').ZodObject<{
+        category: import('zod').ZodString;
+        comment: import('zod').ZodString;
+        severity: import('zod').ZodEnum<["critical", "major", "minor"]>;
+    }, "strip", import('zod').ZodTypeAny, {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }, {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }>, "many">;
+}, "strip", import('zod').ZodTypeAny, {
+    issues: {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }[];
+    score: number;
+    hasMajorIssue: boolean;
+    hasCriticalIssue: boolean;
+}, {
+    issues: {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }[];
+    score: number;
+    hasMajorIssue: boolean;
+    hasCriticalIssue: boolean;
+}>, import('zod').ZodObject<{
+    projectId: import('zod').ZodString;
+    translationId: import('zod').ZodNumber;
+}, "strip", import('zod').ZodTypeAny, {
+    projectId: string;
+    translationId: number;
+}, {
+    projectId: string;
+    translationId: number;
+}>, 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/teamUsers.d.ts

@@ -1,7 +1,7 @@
 /**
  * Public API router definition for getting the details of a team user
  */
-export declare const getTeamUser: import('@lokalise/universal-ts-utils/node').GetRouteDefinition<{
+export declare const getTeamUser: import('@lokalise/api-contracts').GetRouteDefinition<{
     userId: number;
     teamId: number;
 }, import('zod').ZodObject<{

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

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+export declare const GET_SCORE_REQUEST_QUERY_SCHEMA: z.ZodObject<{
+    projectId: z.ZodString;
+    translationId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    projectId: string;
+    translationId: number;
+}, {
+    projectId: string;
+    translationId: number;
+}>;
+export type GetScoreRequestQuery = z.infer<typeof GET_SCORE_REQUEST_QUERY_SCHEMA>;
+export declare const SEVERITY_ENUM: z.ZodEnum<["critical", "major", "minor"]>;
+export type Severity = z.infer<typeof SEVERITY_ENUM>;
+export declare const ISSUE_SCHEMA: z.ZodObject<{
+    category: z.ZodString;
+    comment: z.ZodString;
+    severity: z.ZodEnum<["critical", "major", "minor"]>;
+}, "strip", z.ZodTypeAny, {
+    category: string;
+    comment: string;
+    severity: "critical" | "major" | "minor";
+}, {
+    category: string;
+    comment: string;
+    severity: "critical" | "major" | "minor";
+}>;
+export type Issue = z.infer<typeof ISSUE_SCHEMA>;
+export declare const GET_SCORE_RESPONSE_SCHEMA: z.ZodObject<{
+    score: z.ZodNumber;
+    hasMajorIssue: z.ZodBoolean;
+    hasCriticalIssue: z.ZodBoolean;
+    issues: z.ZodArray<z.ZodObject<{
+        category: z.ZodString;
+        comment: z.ZodString;
+        severity: z.ZodEnum<["critical", "major", "minor"]>;
+    }, "strip", z.ZodTypeAny, {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }, {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    issues: {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }[];
+    score: number;
+    hasMajorIssue: boolean;
+    hasCriticalIssue: boolean;
+}, {
+    issues: {
+        category: string;
+        comment: string;
+        severity: "critical" | "major" | "minor";
+    }[];
+    score: number;
+    hasMajorIssue: boolean;
+    hasCriticalIssue: boolean;
+}>;
+export type GetScoreResponseBody = z.infer<typeof GET_SCORE_RESPONSE_SCHEMA>;

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

@@ -3,7 +3,7 @@ import { z } from 'zod';
  * A method of getting a JWT token for a user.
  * You can call this with either a refresh token or from within the scope of a classic CSRF cookie session.
  */
-export declare const getUserToken: import('@lokalise/universal-ts-utils/node').PayloadRouteDefinition<{
+export declare const getUserToken: import('@lokalise/api-contracts').PayloadRouteDefinition<{
     teamId: number;
 }, z.ZodUndefined, z.ZodObject<{
     accessToken: z.ZodString;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/harmony",
-    "version": "1.22.1",
+    "version": "1.23.0",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com/"
@@ -18,9 +18,7 @@
     "scripts": {
         "build": "rimraf dist && vite build",
         "bundle:size": "bundlesize",
-        "test": "vitest",
-        "test:coverage": "vitest --coverage",
-        "test:ci": "npm run lint && npm run test:coverage",
+        "test": "vitest --coverage",
         "test:update-snapshots": "vitest -u",
         "lint": "biome check . && tsc --project tsconfig.lint.json --noEmit",
         "lint:fix": "biome check --write",
@@ -30,10 +28,10 @@
         "storybook:build": "storybook build"
     },
     "peerDependencies": {
+        "@lokalise/api-contracts": ">=4.3.0",
         "@lokalise/frontend-http-client": ">=3.2.1",
         "@lokalise/louis": ">=26.0.0",
         "@lokalise/token-dictionary": ">=2.42.1",
-        "@lokalise/universal-ts-utils": ">=3.4.0",
         "@tanstack/react-query": ">=5.66.9",
         "date-fns": ">=4.1",
         "date-fns-tz": ">=3.2",
@@ -46,6 +44,7 @@
         "@biomejs/biome": "^1.9.4",
         "@chromatic-com/storybook": "^3.2.5",
         "@faker-js/faker": "^9.6.0",
+        "@lokalise/api-contracts": "^4.3.0",
         "@lokalise/biome-config": "^1.6.1",
         "@semantic-release/changelog": "^6.0.3",
         "@semantic-release/commit-analyzer": "^13.0.1",
@@ -69,7 +68,7 @@
         "@types/react-dom": "18.3.0",
         "@typescript-eslint/parser": "^8.26.1",
         "@vitejs/plugin-react": "^4.3.4",
-        "@vitest/coverage-v8": "^3.0.8",
+        "@vitest/coverage-v8": "^3.1.1",
         "bundlesize2": "^0.0.34",
         "conventional-changelog-conventionalcommits": "^8.0.0",
         "eslint-plugin-i18next": "^6.0.9",
@@ -82,10 +81,10 @@
         "semantic-release": "^24.2.3",
         "storybook": "^8.6.0-alpha.1",
         "typescript": "^5.7.3",
-        "vite": "^6.2.1",
+        "vite": "^6.3.2",
         "vite-plugin-dts": "^4.5.3",
         "vite-plugin-tsconfig-paths": "^1.4.1",
-        "vitest": "^3.0.3"
+        "vitest": "^3.1.1"
     },
     "main": "dist/harmony.cjs",
     "module": "dist/harmony.mjs",