@lokalise/ragnarok-api-contracts 4.0.3 → 5.0.0

package/dist/objects-v2.js

@@ -1,144 +0,0 @@
-import { z } from 'zod';
-import { METRICS_METADATA_SCHEMA } from "./objects.js";
-/**
- * V2 evaluation result objects.
- *
- * Unlike V1 (`objects.ts`), every metric carries coverage and reliability metadata so consumers
- * can distinguish a perfect score from one computed on a degraded segment set, and can tell an
- * unsupported locale pair apart from an integration outage.
- *
- * V1 schemas remain the source of truth for `/v1/...`; these are additive and used only by `/v2/...`.
- */
-/**
- * Reliability classification of a single computed metric:
- * - `perfect`  — computed over the full comparable segment set (`computedSegments === comparableSegments`).
- * - `degraded` — some segments were excluded, but the surviving set still meets the reliability threshold.
- * - `failed`   — too few comparable segments to be trustworthy (below the reliability threshold).
- */
-export const METRIC_STATUS_SCHEMA = z
-    .enum(['perfect', 'degraded', 'failed'])
-    .describe('Reliability classification of the computed metric');
-/**
- * A single metric value paired with the coverage it was computed over and a reliability status.
- */
-export const METRIC_RESULT_SCHEMA = z.object({
-    value: z.number().describe('The computed metric value'),
-    computedSegments: z
-        .number()
-        .int()
-        .min(0)
-        .describe('Number of segments that successfully contributed to this metric'),
-    comparableSegments: z
-        .number()
-        .int()
-        .min(0)
-        .describe('Number of segments in the comparable set for this metric after cross-configuration exclusion. ' +
-        '`computedSegments` is measured against this denominator to derive `status`.'),
-    status: METRIC_STATUS_SCHEMA,
-});
-/**
- * V2 per-locale-pair metrics. Each metric is optional (a metric is omitted when it does not apply,
- * e.g. BLEU for a pair with no corpus-level computation). The whole object is `null` on the
- * locale-pair result when no metrics could be produced (see `LOCALE_PAIR_RESULT_V2_SCHEMA`).
- */
-export const METRICS_V2_SCHEMA = z
-    .object({
-    exactMatch: METRIC_RESULT_SCHEMA.optional().describe('Rate of translations that exactly match the reference (0–1)'),
-    ter: METRIC_RESULT_SCHEMA.optional().describe('TER score measuring post-editing effort relative to reference length'),
-    bleu: METRIC_RESULT_SCHEMA.optional().describe('BLEU score measuring n-gram overlap with reference translations'),
-    meteor: METRIC_RESULT_SCHEMA.optional().describe('METEOR score measuring n-gram overlap with synonym and morphological variant support'),
-    chrf: METRIC_RESULT_SCHEMA.optional().describe('chrF score measuring character n-gram overlap with reference translations'),
-})
-    .describe('Metrics for a single locale pair, each annotated with coverage and reliability');
-/**
- * Outcome of translating a locale pair within a run configuration:
- * - `success`                 — all in-scope segments translated.
- * - `partial_success`         — some segments translated, some failed (metrics computed on the survivors).
- * - `unsupported_locale_pair` — the integration does not support this pair; metrics are `null`. Does
- *                               NOT cause cross-configuration exclusion (other configs are unaffected).
- * - `integration_failure`     — the integration failed to translate the pair (e.g. provider outage);
- *                               metrics are `null` and the pair is excluded from all configs' comparable sets.
- */
-export const TRANSLATION_STATUS_SCHEMA = z
-    .enum(['success', 'partial_success', 'unsupported_locale_pair', 'integration_failure'])
-    .describe('Translation outcome for this locale pair');
-export const LOCALE_PAIR_RESULT_V2_SCHEMA = z
-    .object({
-    sourceLocale: z.string().describe('Source language locale'),
-    targetLocale: z.string().describe('Target language locale'),
-    totalSegments: z
-        .number()
-        .int()
-        .min(0)
-        .describe('Total number of segments in scope for this locale pair'),
-    translatedSegments: z
-        .number()
-        .int()
-        .min(0)
-        .describe('Number of segments that were successfully translated'),
-    translationStatus: TRANSLATION_STATUS_SCHEMA,
-    metrics: METRICS_V2_SCHEMA.nullable().describe('Metrics for this locale pair, or `null` when no metrics could be computed ' +
-        '(`unsupported_locale_pair` or `integration_failure`).'),
-})
-    .describe('V2 evaluation metrics for a single locale pair, with coverage and translation outcome');
-/**
- * A reference to a locale pair, used to list pairs excluded from a global metric aggregate.
- * Intentionally flat (no `reason`): the per-pair `translationStatus` already carries the cause.
- */
-export const LOCALE_PAIR_REF_SCHEMA = z
-    .object({
-    sourceLocale: z.string().describe('Source language locale'),
-    targetLocale: z.string().describe('Target language locale'),
-})
-    .describe('Reference to a locale pair');
-/**
- * A global (cross-locale-pair) aggregate for a single metric. Weighted by comparable segments and
- * annotated with the locale pairs that were excluded from this metric's aggregation.
- */
-export const GLOBAL_METRIC_RESULT_SCHEMA = z.object({
-    value: z.number().describe('The aggregated metric value across all included locale pairs'),
-    computedSegments: z
-        .number()
-        .int()
-        .min(0)
-        .describe('Total segments that contributed to this global metric'),
-    comparableSegments: z
-        .number()
-        .int()
-        .min(0)
-        .describe('Total comparable segments across all included locale pairs for this metric'),
-    status: METRIC_STATUS_SCHEMA,
-    excludedLocalePairs: z
-        .array(LOCALE_PAIR_REF_SCHEMA)
-        .describe('Locale pairs excluded from this metric (failed or non-comparable)'),
-});
-export const GLOBAL_METRICS_V2_SCHEMA = z
-    .object({
-    exactMatch: GLOBAL_METRIC_RESULT_SCHEMA.optional(),
-    ter: GLOBAL_METRIC_RESULT_SCHEMA.optional(),
-    bleu: GLOBAL_METRIC_RESULT_SCHEMA.optional(),
-    meteor: GLOBAL_METRIC_RESULT_SCHEMA.optional(),
-    chrf: GLOBAL_METRIC_RESULT_SCHEMA.optional(),
-})
-    .describe('Per-metric global aggregates across all locale pairs');
-export const CONFIGURATION_RESULT_V2_SCHEMA = z
-    .object({
-    configurationName: z.string().describe('Name of the run configuration'),
-    global: GLOBAL_METRICS_V2_SCHEMA.describe('Metrics aggregated across all locale pairs'),
-    resultsByLocalePair: z
-        .array(LOCALE_PAIR_RESULT_V2_SCHEMA)
-        .describe('Metrics per locale pair, including failed and unsupported pairs'),
-})
-    .describe('V2 evaluation metrics for a single run configuration');
-export const EVALUATION_V2_SCHEMA = z.object({
-    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'),
-    metricsMetadata: METRICS_METADATA_SCHEMA.describe('Per-metric metadata for interpreting evaluation scores'),
-    results: z
-        .array(CONFIGURATION_RESULT_V2_SCHEMA)
-        .nullable()
-        .describe('Evaluation results per run configuration'),
-    metadata: z.record(z.string(), z.unknown()).nullable(),
-});
-//# sourceMappingURL=objects-v2.js.map

package/dist/objects-v2.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"objects-v2.js","sourceRoot":"","sources":["../src/objects-v2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AAEtD;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,IAAI,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;KACvC,QAAQ,CAAC,mDAAmD,CAAC,CAAA;AAIhE;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IACvD,gBAAgB,EAAE,CAAC;SAChB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,iEAAiE,CAAC;IAC9E,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,gGAAgG;QAC9F,6EAA6E,CAChF;IACH,MAAM,EAAE,oBAAoB;CAC7B,CAAC,CAAA;AAIF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,UAAU,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAClD,6DAA6D,CAC9D;IACD,GAAG,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC3C,sEAAsE,CACvE;IACD,IAAI,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC5C,iEAAiE,CAClE;IACD,MAAM,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC9C,sFAAsF,CACvF;IACD,IAAI,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC5C,2EAA2E,CAC5E;CACF,CAAC;KACD,QAAQ,CAAC,gFAAgF,CAAC,CAAA;AAI7F;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,IAAI,CAAC,CAAC,SAAS,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,qBAAqB,CAAC,CAAC;KACtF,QAAQ,CAAC,0CAA0C,CAAC,CAAA;AAIvD,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACN,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC3D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC3D,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,wDAAwD,CAAC;IACrE,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,sDAAsD,CAAC;IACnE,iBAAiB,EAAE,yBAAyB;IAC5C,OAAO,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC5C,4EAA4E;QAC1E,uDAAuD,CAC1D;CACF,CAAC;KACD,QAAQ,CAAC,uFAAuF,CAAC,CAAA;AAIpG;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC3D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CAC5D,CAAC;KACD,QAAQ,CAAC,4BAA4B,CAAC,CAAA;AAIzC;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8DAA8D,CAAC;IAC1F,gBAAgB,EAAE,CAAC;SAChB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,uDAAuD,CAAC;IACpE,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,4EAA4E,CAAC;IACzF,MAAM,EAAE,oBAAoB;IAC5B,mBAAmB,EAAE,CAAC;SACnB,KAAK,CAAC,sBAAsB,CAAC;SAC7B,QAAQ,CAAC,mEAAmE,CAAC;CACjF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,UAAU,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IAClD,GAAG,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IAC9C,IAAI,EAAE,2BAA2B,CAAC,QAAQ,EAAE;CAC7C,CAAC;KACD,QAAQ,CAAC,sDAAsD,CAAC,CAAA;AAInE,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACvE,MAAM,EAAE,wBAAwB,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IACvF,mBAAmB,EAAE,CAAC;SACnB,KAAK,CAAC,4BAA4B,CAAC;SACnC,QAAQ,CAAC,iEAAiE,CAAC;CAC/E,CAAC;KACD,QAAQ,CAAC,sDAAsD,CAAC,CAAA;AAInE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,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,eAAe,EAAE,uBAAuB,CAAC,QAAQ,CAC/C,wDAAwD,CACzD;IACD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,8BAA8B,CAAC;SACrC,QAAQ,EAAE;SACV,QAAQ,CAAC,0CAA0C,CAAC;IACvD,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAA"}