@lokalise/polyglot-sdk 8.0.0 → 9.0.0

package/dist/sdk/schemas/lqa/lqaAsyncV1Schemas.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LQA_ASYNC_V1_CALLBACK_SCHEMA = exports.LQA_ASYNC_V1_RESPONSE_SCHEMA = exports.LQA_ASYNC_V1_HEADERS_SCHEMA = exports.LQA_ASYNC_V1_BODY_SCHEMA = void 0;
+const tslib_1 = require("tslib");
+const zod_1 = tslib_1.__importDefault(require("zod"));
+const asyncRequestSchemas_1 = require("../common/asyncRequestSchemas");
+const commonSchemas_1 = require("../common/commonSchemas");
+const requestContextSchemas_1 = require("../common/requestContextSchemas");
+const commonSchemas_2 = require("./commonSchemas");
+const LQA_TRANSLATION_VALUE_MAX_LENGTH = 5000;
+const LQA_SEGMENT_SOURCE_VALUE_MAX_LENGTH = 5000;
+const LQA_SEGMENT_TRANSLATIONS_MAX_LENGTH = 10;
+const LQA_CONTENT_UNIT_DESCRIPTION_MAX_LENGTH = 500;
+const LQA_CONTENT_UNIT_SEGMENTS_MAX_LENGTH = 500;
+const LQA_CONTENT_UNITS_MAX_LENGTH = 50;
+const LQA_TRANSLATION_ID_SCHEMA = zod_1.default.string().uuid().describe('Unique ID of the segment translation');
+const LQA_TRANSLATION_SCHEMA = zod_1.default.object({
+    id: LQA_TRANSLATION_ID_SCHEMA,
+    locale: commonSchemas_1.LOCALE_SCHEMA,
+    value: zod_1.default
+        .string()
+        .min(1)
+        .max(LQA_TRANSLATION_VALUE_MAX_LENGTH)
+        .describe('Translation of this segment in target language'),
+});
+const LQA_SEGMENT_SCHEMA = zod_1.default.object({
+    sourceValue: zod_1.default
+        .string()
+        .min(1)
+        .max(LQA_SEGMENT_SOURCE_VALUE_MAX_LENGTH)
+        .describe('Text content of the segment in source language'),
+    translations: zod_1.default
+        .array(LQA_TRANSLATION_SCHEMA)
+        .nonempty()
+        .max(LQA_SEGMENT_TRANSLATIONS_MAX_LENGTH)
+        .describe('List of translations for this segment'),
+    tmMatch: commonSchemas_1.TM_MATCH_SCHEMA,
+});
+const LQA_CONTENT_UNIT_ID_SCHEMA = zod_1.default.string().uuid().describe('Unique ID of the content unit');
+const LQA_CONTENT_UNIT_SCHEMA = zod_1.default.object({
+    id: LQA_CONTENT_UNIT_ID_SCHEMA,
+    context: zod_1.default
+        .object({
+        description: zod_1.default
+            .string()
+            .min(1)
+            .max(LQA_CONTENT_UNIT_DESCRIPTION_MAX_LENGTH)
+            .describe('Unit description, something that applies to each segment in a unit. This will be passed as a helpful context to LLM calls')
+            .optional(),
+    })
+        .optional(),
+    segments: zod_1.default
+        .array(LQA_SEGMENT_SCHEMA)
+        .nonempty()
+        .max(LQA_CONTENT_UNIT_SEGMENTS_MAX_LENGTH)
+        .describe('List of segments to be reviewed'),
+    characterLimit: zod_1.default.number().optional(),
+});
+exports.LQA_ASYNC_V1_BODY_SCHEMA = asyncRequestSchemas_1.ASYNC_REQUEST_SCHEMA.extend({
+    sourceLocale: commonSchemas_1.LOCALE_SCHEMA,
+    integration: commonSchemas_1.AI_INTEGRATION_ENGINE_SCHEMA.optional(),
+    context: requestContextSchemas_1.REQUEST_CONTEXT_SCHEMA.optional(),
+    contentUnits: zod_1.default
+        .array(LQA_CONTENT_UNIT_SCHEMA)
+        .nonempty()
+        .max(LQA_CONTENT_UNITS_MAX_LENGTH)
+        .describe('A list of content units to be reviewed. Each unit might have 1 or more segments, but all segments in content unit are considered to be parts of the same piece of content.'),
+});
+exports.LQA_ASYNC_V1_HEADERS_SCHEMA = commonSchemas_1.COMMON_REQUEST_HEADERS_SCHEMA;
+exports.LQA_ASYNC_V1_RESPONSE_SCHEMA = zod_1.default
+    .object({
+    requestId: zod_1.default.string().uuid(),
+    expectedAt: zod_1.default.string().datetime(),
+})
+    .describe('Accepted for processing. Await the callback for the results.');
+exports.LQA_ASYNC_V1_CALLBACK_SCHEMA = zod_1.default
+    .object({
+    originCorrelationId: zod_1.default.string(),
+    data: zod_1.default.array(zod_1.default.object({
+        contentUnitId: LQA_CONTENT_UNIT_ID_SCHEMA,
+        translationId: LQA_TRANSLATION_ID_SCHEMA,
+        suggestion: zod_1.default.string().nullable().optional(),
+        issues: zod_1.default.array(zod_1.default.object({
+            category: zod_1.default.nativeEnum(commonSchemas_2.LqaIssueCategoryEnum),
+            severity: zod_1.default.nativeEnum(commonSchemas_2.LqaIssueSeverityEnum),
+            comment: zod_1.default.string().nullable().optional(),
+        })),
+    })),
+    errors: zod_1.default
+        .array(commonSchemas_1.COMMON_ERROR_RESPONSE_SCHEMA.extend({
+        contentUnitId: LQA_CONTENT_UNIT_ID_SCHEMA,
+        translationId: LQA_TRANSLATION_ID_SCHEMA,
+    }))
+        .optional(),
+})
+    .describe('Callback with results.');
+//# sourceMappingURL=lqaAsyncV1Schemas.js.map

package/dist/sdk/schemas/lqa/lqaAsyncV1Schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lqaAsyncV1Schemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/lqa/lqaAsyncV1Schemas.ts"],"names":[],"mappings":";;;;AAAA,sDAAmB;AAEnB,uEAAoE;AACpE,2DAMgC;AAChC,2EAAwE;AAExE,mDAA4E;AAE5E,MAAM,gCAAgC,GAAG,IAAI,CAAA;AAC7C,MAAM,mCAAmC,GAAG,IAAI,CAAA;AAChD,MAAM,mCAAmC,GAAG,EAAE,CAAA;AAC9C,MAAM,uCAAuC,GAAG,GAAG,CAAA;AACnD,MAAM,oCAAoC,GAAG,GAAG,CAAA;AAChD,MAAM,4BAA4B,GAAG,EAAE,CAAA;AAEvC,MAAM,yBAAyB,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC,CAAA;AAEpG,MAAM,sBAAsB,GAAG,aAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,yBAAyB;IAC7B,MAAM,EAAE,6BAAa;IACrB,KAAK,EAAE,aAAC;SACL,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,gCAAgC,CAAC;SACrC,QAAQ,CAAC,gDAAgD,CAAC;CAC9D,CAAC,CAAA;AAEF,MAAM,kBAAkB,GAAG,aAAC,CAAC,MAAM,CAAC;IAClC,WAAW,EAAE,aAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,mCAAmC,CAAC;SACxC,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,YAAY,EAAE,aAAC;SACZ,KAAK,CAAC,sBAAsB,CAAC;SAC7B,QAAQ,EAAE;SACV,GAAG,CAAC,mCAAmC,CAAC;SACxC,QAAQ,CAAC,uCAAuC,CAAC;IACpD,OAAO,EAAE,+BAAe;CACzB,CAAC,CAAA;AAEF,MAAM,0BAA0B,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC,CAAA;AAE9F,MAAM,uBAAuB,GAAG,aAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,0BAA0B;IAC9B,OAAO,EAAE,aAAC;SACP,MAAM,CAAC;QACN,WAAW,EAAE,aAAC;aACX,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,uCAAuC,CAAC;aAC5C,QAAQ,CACP,2HAA2H,CAC5H;aACA,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,EAAE;IACb,QAAQ,EAAE,aAAC;SACR,KAAK,CAAC,kBAAkB,CAAC;SACzB,QAAQ,EAAE;SACV,GAAG,CAAC,oCAAoC,CAAC;SACzC,QAAQ,CAAC,iCAAiC,CAAC;IAC9C,cAAc,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAA;AAEW,QAAA,wBAAwB,GAAG,0CAAoB,CAAC,MAAM,CAAC;IAClE,YAAY,EAAE,6BAAa;IAC3B,WAAW,EAAE,4CAA4B,CAAC,QAAQ,EAAE;IACpD,OAAO,EAAE,8CAAsB,CAAC,QAAQ,EAAE;IAC1C,YAAY,EAAE,aAAC;SACZ,KAAK,CAAC,uBAAuB,CAAC;SAC9B,QAAQ,EAAE;SACV,GAAG,CAAC,4BAA4B,CAAC;SACjC,QAAQ,CACP,4KAA4K,CAC7K;CACJ,CAAC,CAAA;AAEW,QAAA,2BAA2B,GAAG,6CAA6B,CAAA;AAE3D,QAAA,4BAA4B,GAAG,aAAC;KAC1C,MAAM,CAAC;IACN,SAAS,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,UAAU,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC;KACD,QAAQ,CAAC,8DAA8D,CAAC,CAAA;AAE9D,QAAA,4BAA4B,GAAG,aAAC;KAC1C,MAAM,CAAC;IACN,mBAAmB,EAAE,aAAC,CAAC,MAAM,EAAE;IAC/B,IAAI,EAAE,aAAC,CAAC,KAAK,CACX,aAAC,CAAC,MAAM,CAAC;QACP,aAAa,EAAE,0BAA0B;QACzC,aAAa,EAAE,yBAAyB;QACxC,UAAU,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAC5C,MAAM,EAAE,aAAC,CAAC,KAAK,CACb,aAAC,CAAC,MAAM,CAAC;YACP,QAAQ,EAAE,aAAC,CAAC,UAAU,CAAC,oCAAoB,CAAC;YAC5C,QAAQ,EAAE,aAAC,CAAC,UAAU,CAAC,oCAAoB,CAAC;YAC5C,OAAO,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;SAC1C,CAAC,CACH;KACF,CAAC,CACH;IACD,MAAM,EAAE,aAAC;SACN,KAAK,CACJ,4CAA4B,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,0BAA0B;QACzC,aAAa,EAAE,yBAAyB;KACzC,CAAC,CACH;SACA,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,wBAAwB,CAAC,CAAA"}