@lokalise/ragnarok-api-contracts 1.1.0 → 2.1.0

package/dist/common.d.ts

@@ -2,6 +2,20 @@ import { z } from 'zod';
 export declare const AUTH_HEADERS: z.ZodObject<{
     authorization: z.ZodString;
 }, z.core.$strip>;
+export declare const METADATA_SCHEMA: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export type Metadata = z.infer<typeof METADATA_SCHEMA>;
+export declare const INTEGRATION_INPUT_SCHEMA: z.ZodObject<{
+    engine: z.ZodOptional<z.ZodEnum<{
+        readonly CLAUDE: "Claude";
+        readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+        readonly GPT: "GPT";
+        readonly GEMINI: "Gemini";
+        readonly DEEPL: "DeepL";
+        readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+    }>>;
+    isForced: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type IntegrationInput = z.infer<typeof INTEGRATION_INPUT_SCHEMA>;
 export declare const WEBHOOK_SCHEMA: z.ZodObject<{
     url: z.ZodURL;
     headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;

package/dist/common.js

@@ -1,7 +1,20 @@
+import { RealIntegrationEngineEnum } from '@lokalise/polyglot-sdk';
 import { z } from 'zod';
 export const AUTH_HEADERS = z.object({
     authorization: z.string(),
 });
+export const METADATA_SCHEMA = z
+    .record(z.string(), z.unknown())
+    .describe('A free-form object that can be used to provide some additional info');
+export const INTEGRATION_INPUT_SCHEMA = z
+    .object({
+    engine: z.enum(RealIntegrationEngineEnum).optional().describe('Preferred translation engine'),
+    isForced: z
+        .boolean()
+        .default(false)
+        .describe('If true, the request will fail if the engine is unavailable instead of falling back'),
+})
+    .describe('A preferred integration to be used for Translation');
 export const WEBHOOK_SCHEMA = z
     .object({
     url: z

package/dist/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;CAC1B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,GAAG,EAAE,CAAC;SACH,GAAG,EAAE;SACL,GAAG,CAAC,IAAI,CAAC;SACT,QAAQ,CACP,2FAA2F,CAC5F;IACH,OAAO,EAAE,CAAC;SACP,MAAM,CACL,CAAC;SACE,MAAM,EAAE;SACR,KAAK,CAAC,iBAAiB,EAAE;QACxB,OAAO,EAAE,6DAA6D;KACvE,CAAC;SACD,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,CAAC,yDAAyD,CAAC,EACtE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,mDAAmD,CAAC,CAC1F;SACA,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC;KACD,QAAQ,CAAC,sEAAsE,CAAC,CAAA"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;CAC1B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KAC/B,QAAQ,CAAC,qEAAqE,CAAC,CAAA;AAIlF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC7F,QAAQ,EAAE,CAAC;SACR,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CACP,qFAAqF,CACtF;CACJ,CAAC;KACD,QAAQ,CAAC,oDAAoD,CAAC,CAAA;AAIjE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,GAAG,EAAE,CAAC;SACH,GAAG,EAAE;SACL,GAAG,CAAC,IAAI,CAAC;SACT,QAAQ,CACP,2FAA2F,CAC5F;IACH,OAAO,EAAE,CAAC;SACP,MAAM,CACL,CAAC;SACE,MAAM,EAAE;SACR,KAAK,CAAC,iBAAiB,EAAE;QACxB,OAAO,EAAE,6DAA6D;KACvE,CAAC;SACD,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,CAAC,yDAAyD,CAAC,EACtE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,mDAAmD,CAAC,CAC1F;SACA,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC;KACD,QAAQ,CAAC,sEAAsE,CAAC,CAAA"}

package/dist/evaluation-contracts.d.ts

@@ -11,6 +11,24 @@ export declare const getEvaluation: import("@lokalise/api-contracts").GetRouteDe
         completed: "completed";
         failed: "failed";
     }>;
+    resultByConfigurationName: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
+        global: z.ZodObject<{
+            referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+            actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+            perfectMatch: z.ZodOptional<z.ZodNumber>;
+            translationErrorRate: z.ZodOptional<z.ZodNumber>;
+            bleu: z.ZodOptional<z.ZodNumber>;
+            meteor: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$catchall<z.ZodObject<{
+        referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+        actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+        perfectMatch: z.ZodOptional<z.ZodNumber>;
+        translationErrorRate: z.ZodOptional<z.ZodNumber>;
+        bleu: z.ZodOptional<z.ZodNumber>;
+        meteor: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>>>;
+    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>, z.ZodObject<{
     evaluationId: z.ZodUUID;
 }, z.core.$strip>, undefined, z.ZodObject<{
@@ -19,6 +37,55 @@ export declare const getEvaluation: import("@lokalise/api-contracts").GetRouteDe
 export declare const DATASET_INPUT_SCHEMA: z.ZodObject<{
     fileUrl: z.ZodURL;
 }, z.core.$strip>;
+export declare const RUN_CONFIGURATION_INPUT_SCHEMA: z.ZodObject<{
+    name: z.ZodString;
+    integration: z.ZodOptional<z.ZodObject<{
+        engine: z.ZodOptional<z.ZodEnum<{
+            readonly CLAUDE: "Claude";
+            readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+            readonly GPT: "GPT";
+            readonly GEMINI: "Gemini";
+            readonly DEEPL: "DeepL";
+            readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+        }>>;
+        isForced: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    useExamples: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    useStyleguide: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    useGlossary: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    useDescriptions: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type RunConfigurationInput = z.infer<typeof RUN_CONFIGURATION_INPUT_SCHEMA>;
+declare const SCHEDULE_EVALUATION_BODY_SCHEMA: z.ZodObject<{
+    ownerId: z.ZodString;
+    datasets: z.ZodArray<z.ZodObject<{
+        fileUrl: z.ZodURL;
+    }, z.core.$strip>>;
+    webhook: z.ZodObject<{
+        url: z.ZodURL;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>;
+    runConfigurations: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        integration: z.ZodOptional<z.ZodObject<{
+            engine: z.ZodOptional<z.ZodEnum<{
+                readonly CLAUDE: "Claude";
+                readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+                readonly GPT: "GPT";
+                readonly GEMINI: "Gemini";
+                readonly DEEPL: "DeepL";
+                readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+            }>>;
+            isForced: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        useExamples: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        useStyleguide: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        useGlossary: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        useDescriptions: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+export type ScheduleEvaluationInput = z.infer<typeof SCHEDULE_EVALUATION_BODY_SCHEMA>;
 export declare const postScheduleEvaluation: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodObject<{
     ownerId: z.ZodString;
     datasets: z.ZodArray<z.ZodObject<{
@@ -28,6 +95,25 @@ export declare const postScheduleEvaluation: import("@lokalise/api-contracts").P
         url: z.ZodURL;
         headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>;
+    runConfigurations: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        integration: z.ZodOptional<z.ZodObject<{
+            engine: z.ZodOptional<z.ZodEnum<{
+                readonly CLAUDE: "Claude";
+                readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+                readonly GPT: "GPT";
+                readonly GEMINI: "Gemini";
+                readonly DEEPL: "DeepL";
+                readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+            }>>;
+            isForced: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        useExamples: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        useStyleguide: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        useGlossary: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        useDescriptions: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>, z.ZodObject<{
     evaluationId: z.ZodUUID;
 }, z.core.$strip>, undefined, undefined, z.ZodObject<{

package/dist/evaluation-contracts.js

@@ -1,6 +1,6 @@
 import { buildRestContract } from '@lokalise/api-contracts';
 import { z } from 'zod';
-import { AUTH_HEADERS, WEBHOOK_SCHEMA } from "./common.js";
+import { AUTH_HEADERS, INTEGRATION_INPUT_SCHEMA, METADATA_SCHEMA, WEBHOOK_SCHEMA, } from "./common.js";
 import { EVALUATION_SCHEMA } from "./objects.js";
 const GET_EVALUATION_SCHEMA = z.object({
     evaluationId: z.uuid().describe('The unique identifier of the evaluation to retrieve.'),
@@ -16,16 +16,58 @@ export const getEvaluation = buildRestContract({
 export const DATASET_INPUT_SCHEMA = z.object({
     fileUrl: z.url().describe('Presigned URL to the JSONL dataset file'),
 });
+export const RUN_CONFIGURATION_INPUT_SCHEMA = z.object({
+    name: z
+        .string()
+        .min(1)
+        .describe('A unique (within the request) identifier for the configuration'),
+    integration: INTEGRATION_INPUT_SCHEMA.optional().describe('A preferred integration to be used for Translation'),
+    useExamples: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('If false, will not send translation examples with Translation calls.'),
+    useStyleguide: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('If false, will not send styleguide with Translation calls.'),
+    useGlossary: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('If false, will not send glossary terms with Translation calls.'),
+    useDescriptions: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('If false, will not send neither global nor per-item descriptions with Translation calls.'),
+});
+const SCHEDULE_EVALUATION_BODY_SCHEMA = z
+    .object({
+    ownerId: z
+        .string()
+        .min(1)
+        .describe('Owner identifier (team ID or similar) for this evaluation'),
+    datasets: z.array(DATASET_INPUT_SCHEMA).min(1).describe('Dataset files to process'),
+    webhook: WEBHOOK_SCHEMA.describe('Webhook for completion notification'),
+    runConfigurations: z
+        .array(RUN_CONFIGURATION_INPUT_SCHEMA)
+        .min(1, 'At least one run configuration is required')
+        .max(10, 'Maximum 10 run configurations allowed')
+        .describe('A list of configurations to evaluate using dataset items and aggregate metrics on.'),
+    metadata: METADATA_SCHEMA.optional(),
+})
+    .refine((data) => {
+    const names = data.runConfigurations.map((c) => c.name);
+    return new Set(names).size === names.length;
+}, { message: 'Run configuration names must be unique within the request' });
 export const postScheduleEvaluation = buildRestContract({
     method: 'post',
     pathResolver: () => '/v1/evaluations',
     description: 'Schedule evaluation',
     requestHeaderSchema: AUTH_HEADERS,
-    requestBodySchema: z.object({
-        ownerId: z.string().describe('Owner identifier (team ID or similar) for this evaluation'),
-        datasets: z.array(DATASET_INPUT_SCHEMA).min(1).describe('Dataset files to process'),
-        webhook: WEBHOOK_SCHEMA.describe('Webhook for completion notification'),
-    }),
+    requestBodySchema: SCHEDULE_EVALUATION_BODY_SCHEMA,
     successResponseBodySchema: z.object({
         evaluationId: z
             .uuid()

package/dist/evaluation-contracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"evaluation-contracts.js","sourceRoot":"","sources":["../src/evaluation-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;CACxF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,iBAAiB,CAAC;IAC7C,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,mBAAmB,MAAM,CAAC,YAAY,EAAE;IACvF,WAAW,EAAE,2BAA2B;IACxC,uBAAuB,EAAE,qBAAqB;IAC9C,mBAAmB,EAAE,YAAY;IACjC,yBAAyB,EAAE,iBAAiB;CAC7C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;CACrE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB;IACrC,WAAW,EAAE,qBAAqB;IAClC,mBAAmB,EAAE,YAAY;IACjC,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2DAA2D,CAAC;QACzF,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC;QACnF,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC,qCAAqC,CAAC;KACxE,CAAC;IACF,yBAAyB,EAAE,CAAC,CAAC,MAAM,CAAC;QAClC,YAAY,EAAE,CAAC;aACZ,IAAI,EAAE;aACN,QAAQ,CACP,qGAAqG,CACtG;KACJ,CAAC;CACH,CAAC,CAAA"}
+{"version":3,"file":"evaluation-contracts.js","sourceRoot":"","sources":["../src/evaluation-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EACL,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,cAAc,GACf,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;CACxF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,iBAAiB,CAAC;IAC7C,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,mBAAmB,MAAM,CAAC,YAAY,EAAE;IACvF,WAAW,EAAE,2BAA2B;IACxC,uBAAuB,EAAE,qBAAqB;IAC9C,mBAAmB,EAAE,YAAY;IACjC,yBAAyB,EAAE,iBAAiB;CAC7C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;CACrE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,WAAW,EAAE,wBAAwB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACvD,oDAAoD,CACrD;IACD,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,sEAAsE,CAAC;IACnF,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,4DAA4D,CAAC;IACzE,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,eAAe,EAAE,CAAC;SACf,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CACP,0FAA0F,CAC3F;CACJ,CAAC,CAAA;AAIF,MAAM,+BAA+B,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,2DAA2D,CAAC;IACxE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACnF,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IACvE,iBAAiB,EAAE,CAAC;SACjB,KAAK,CAAC,8BAA8B,CAAC;SACrC,GAAG,CAAC,CAAC,EAAE,4CAA4C,CAAC;SACpD,GAAG,CAAC,EAAE,EAAE,uCAAuC,CAAC;SAChD,QAAQ,CACP,oFAAoF,CACrF;IACH,QAAQ,EAAE,eAAe,CAAC,QAAQ,EAAE;CACrC,CAAC;KACD,MAAM,CACL,CAAC,IAAI,EAAE,EAAE;IACP,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACvD,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,CAAA;AAC7C,CAAC,EACD,EAAE,OAAO,EAAE,2DAA2D,EAAE,CACzE,CAAA;AAIH,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB;IACrC,WAAW,EAAE,qBAAqB;IAClC,mBAAmB,EAAE,YAAY;IACjC,iBAAiB,EAAE,+BAA+B;IAClD,yBAAyB,EAAE,CAAC,CAAC,MAAM,CAAC;QAClC,YAAY,EAAE,CAAC;aACZ,IAAI,EAAE;aACN,QAAQ,CACP,qGAAqG,CACtG;KACJ,CAAC;CACH,CAAC,CAAA"}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { AUTH_HEADERS } from './common.ts';
+export * from './common.ts';
 export * from './evaluation-contracts.ts';
 export * from './objects.ts';

package/dist/index.js

@@ -1,4 +1,4 @@
-export { AUTH_HEADERS } from "./common.js";
+export * from "./common.js";
 export * from "./evaluation-contracts.js";
 export * from "./objects.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,2BAA2B,CAAA;AACzC,cAAc,cAAc,CAAA"}

package/dist/objects.d.ts

@@ -1,4 +1,40 @@
 import { z } from 'zod';
+export declare const CONFIGURATION_RESULT_SCHEMA: z.ZodObject<{
+    global: z.ZodObject<{
+        referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+        actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+        perfectMatch: z.ZodOptional<z.ZodNumber>;
+        translationErrorRate: z.ZodOptional<z.ZodNumber>;
+        bleu: z.ZodOptional<z.ZodNumber>;
+        meteor: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$catchall<z.ZodObject<{
+    referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+    actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+    perfectMatch: z.ZodOptional<z.ZodNumber>;
+    translationErrorRate: z.ZodOptional<z.ZodNumber>;
+    bleu: z.ZodOptional<z.ZodNumber>;
+    meteor: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>>;
+export type ConfigurationResult = z.infer<typeof CONFIGURATION_RESULT_SCHEMA>;
+export declare const RESULT_BY_CONFIGURATION_NAME_SCHEMA: z.ZodRecord<z.ZodString, z.ZodObject<{
+    global: z.ZodObject<{
+        referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+        actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+        perfectMatch: z.ZodOptional<z.ZodNumber>;
+        translationErrorRate: z.ZodOptional<z.ZodNumber>;
+        bleu: z.ZodOptional<z.ZodNumber>;
+        meteor: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$catchall<z.ZodObject<{
+    referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+    actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+    perfectMatch: z.ZodOptional<z.ZodNumber>;
+    translationErrorRate: z.ZodOptional<z.ZodNumber>;
+    bleu: z.ZodOptional<z.ZodNumber>;
+    meteor: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>>>;
+export type ResultByConfigurationName = z.infer<typeof RESULT_BY_CONFIGURATION_NAME_SCHEMA>;
 export declare const EVALUATION_SCHEMA: z.ZodObject<{
     id: z.ZodUUID;
     ownerId: z.ZodString;
@@ -7,5 +43,23 @@ export declare const EVALUATION_SCHEMA: z.ZodObject<{
         completed: "completed";
         failed: "failed";
     }>;
+    resultByConfigurationName: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
+        global: z.ZodObject<{
+            referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+            actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+            perfectMatch: z.ZodOptional<z.ZodNumber>;
+            translationErrorRate: z.ZodOptional<z.ZodNumber>;
+            bleu: z.ZodOptional<z.ZodNumber>;
+            meteor: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$catchall<z.ZodObject<{
+        referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
+        actualTranslationScore: z.ZodOptional<z.ZodNumber>;
+        perfectMatch: z.ZodOptional<z.ZodNumber>;
+        translationErrorRate: z.ZodOptional<z.ZodNumber>;
+        bleu: z.ZodOptional<z.ZodNumber>;
+        meteor: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>>>;
+    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
 export type Evaluation = z.infer<typeof EVALUATION_SCHEMA>;

package/dist/objects.js

@@ -1,7 +1,41 @@
 import { z } from 'zod';
+const METRICS_SCHEMA = z.object({
+    referenceTranslationScore: z
+        .number()
+        .optional()
+        .describe('Average LQA score of reference translations'),
+    actualTranslationScore: z
+        .number()
+        .optional()
+        .describe('Average LQA score of actual (generated) translations'),
+    perfectMatch: z
+        .number()
+        .optional()
+        .describe('Rate of translations that exactly match the reference (0–1)'),
+    translationErrorRate: z
+        .number()
+        .optional()
+        .describe('TER score measuring post-editing effort relative to reference length'),
+    bleu: z
+        .number()
+        .optional()
+        .describe('BLEU score measuring n-gram overlap with reference translations'),
+    meteor: z.number().optional().describe('METEOR score measuring translation quality'),
+});
+export const CONFIGURATION_RESULT_SCHEMA = z
+    .object({
+    global: METRICS_SCHEMA.describe('Aggregated metrics across all language pairs for this configuration'),
+})
+    .catchall(METRICS_SCHEMA)
+    .describe('Metrics keyed by language pair (e.g. "en->pl") plus a "global" aggregate');
+export const RESULT_BY_CONFIGURATION_NAME_SCHEMA = z
+    .record(z.string(), CONFIGURATION_RESULT_SCHEMA)
+    .describe('Evaluation results grouped by configuration name');
 export const EVALUATION_SCHEMA = z.object({
-    id: z.uuid(),
-    ownerId: z.string(),
-    status: z.enum(['pending', 'completed', 'failed']),
+    id: z.uuid().describe('Unique identifier of the evaluation request'),
+    ownerId: z.string().describe('Owner identifier (team ID or similar) for this evaluation'),
+    status: z.enum(['pending', 'completed', 'failed']).describe('Current status of the evaluation'),
+    resultByConfigurationName: RESULT_BY_CONFIGURATION_NAME_SCHEMA.nullable(),
+    metadata: z.record(z.string(), z.unknown()).nullable(),
 });
 //# sourceMappingURL=objects.js.map

package/dist/objects.js.map

@@ -1 +1 @@
-{"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;CACnD,CAAC,CAAA"}
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,yBAAyB,EAAE,CAAC;SACzB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC;IAC1D,sBAAsB,EAAE,CAAC;SACtB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sEAAsE,CAAC;IACnF,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,iEAAiE,CAAC;IAC9E,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;CACrF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,CAAC;IACN,MAAM,EAAE,cAAc,CAAC,QAAQ,CAC7B,qEAAqE,CACtE;CACF,CAAC;KACD,QAAQ,CAAC,cAAc,CAAC;KACxB,QAAQ,CAAC,0EAA0E,CAAC,CAAA;AAIvF,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC;KACjD,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,2BAA2B,CAAC;KAC/C,QAAQ,CAAC,kDAAkD,CAAC,CAAA;AAI/D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;IACpE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2DAA2D,CAAC;IACzF,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAC/F,yBAAyB,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IACzE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/ragnarok-api-contracts",
-    "version": "1.1.0",
+    "version": "2.1.0",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com"