@lokalise/polyglot-sdk 6.1.0 → 8.0.0

package/dist/sdk/schemas/translation/asyncTranslationV2Schemas.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRANSLATE_ASYNC_V2_CALLBACK_SCHEMA = exports.TRANSLATE_ASYNC_V2_RESPONSE_SCHEMA = exports.TRANSLATE_ASYNC_V2_HEADERS_SCHEMA = exports.TRANSLATE_ASYNC_V2_BODY_SCHEMA = exports.TRANSLATE_ASYNC_V2_CONTENT_UNIT_SCHEMA = exports.TRANSLATE_ASYNC_V2_SEGMENT_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 sharedSchemas_1 = require("./sharedSchemas");
+const SEGMENT_ID_MAX_LENGTH = 100;
+const SEGMENT_VALUE_MAX_LENGTH = 5000;
+const CONTENT_UNIT_ID_MAX_LENGTH = 100;
+const CONTENT_UNIT_DESCRIPTION_MAX_LENGTH = 500;
+const CONTENT_UNIT_SEGMENTS_MAX_LENGTH = 500;
+const CONTENT_UNITS_MAX_LENGTH = 50;
+const TRANSLATE_ASYNC_V2_SEGMENT_ID_SCHEMA = zod_1.default.string().min(1).max(SEGMENT_ID_MAX_LENGTH);
+exports.TRANSLATE_ASYNC_V2_SEGMENT_SCHEMA = zod_1.default.object({
+    id: TRANSLATE_ASYNC_V2_SEGMENT_ID_SCHEMA,
+    tmMatch: commonSchemas_1.TM_MATCH_SCHEMA,
+    value: zod_1.default.string().min(1).max(SEGMENT_VALUE_MAX_LENGTH),
+});
+const TRANSLATE_ASYNC_V2_CONTENT_UNIT_ID_SCHEMA = zod_1.default.string().min(1).max(CONTENT_UNIT_ID_MAX_LENGTH);
+exports.TRANSLATE_ASYNC_V2_CONTENT_UNIT_SCHEMA = zod_1.default.object({
+    id: TRANSLATE_ASYNC_V2_CONTENT_UNIT_ID_SCHEMA,
+    context: zod_1.default
+        .object({
+        description: zod_1.default.string().min(1).max(CONTENT_UNIT_DESCRIPTION_MAX_LENGTH),
+    })
+        .optional(),
+    characterLimit: zod_1.default.number().optional(),
+    segments: zod_1.default
+        .array(exports.TRANSLATE_ASYNC_V2_SEGMENT_SCHEMA)
+        .nonempty()
+        .max(CONTENT_UNIT_SEGMENTS_MAX_LENGTH)
+        .refine((data) => {
+        const ids = data.map(({ id }) => id);
+        return new Set(ids).size === ids.length;
+    }, 'Segment id must be unique within contentUnit'),
+});
+exports.TRANSLATE_ASYNC_V2_BODY_SCHEMA = asyncRequestSchemas_1.ASYNC_REQUEST_SCHEMA.extend({
+    sourceLocale: commonSchemas_1.LOCALE_SCHEMA,
+    targetLocale: commonSchemas_1.LOCALE_SCHEMA,
+    integration: commonSchemas_1.REAL_INTEGRATION_ENGINE_SCHEMA.optional(),
+    pickIntegrationByScore: zod_1.default.boolean().default(false),
+    context: requestContextSchemas_1.REQUEST_CONTEXT_SCHEMA.optional(),
+    contentUnits: zod_1.default
+        .array(exports.TRANSLATE_ASYNC_V2_CONTENT_UNIT_SCHEMA)
+        .nonempty()
+        .max(CONTENT_UNITS_MAX_LENGTH)
+        .refine((data) => {
+        const ids = data.map(({ id }) => id);
+        return new Set(ids).size === ids.length;
+    }, 'ContentUnit id must be unique within request'),
+})
+    .refine(...sharedSchemas_1.refineDifferentSourceAndTargetLang)
+    .refine((data) => {
+    return !(data.integration && data.pickIntegrationByScore);
+}, 'Forced integration cannot be specified when "pickIntegrationByScore" is enabled.');
+exports.TRANSLATE_ASYNC_V2_HEADERS_SCHEMA = commonSchemas_1.COMMON_REQUEST_HEADERS_SCHEMA;
+exports.TRANSLATE_ASYNC_V2_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.TRANSLATE_ASYNC_V2_CALLBACK_SCHEMA = zod_1.default
+    .object({
+    originCorrelationId: zod_1.default.string(),
+    data: zod_1.default.array(zod_1.default.object({
+        contentUnitId: TRANSLATE_ASYNC_V2_SEGMENT_ID_SCHEMA,
+        segmentId: TRANSLATE_ASYNC_V2_SEGMENT_ID_SCHEMA,
+        polyglotRefId: zod_1.default.string(),
+        integration: zod_1.default.string(),
+        translation: zod_1.default.string(),
+        score: zod_1.default.number().nullable(),
+    })),
+    errors: zod_1.default
+        .array(commonSchemas_1.COMMON_ERROR_RESPONSE_SCHEMA.extend({
+        contentUnitId: TRANSLATE_ASYNC_V2_SEGMENT_ID_SCHEMA,
+        segmentId: TRANSLATE_ASYNC_V2_SEGMENT_ID_SCHEMA,
+        polyglotRefId: zod_1.default.string(),
+        integration: zod_1.default.string(),
+    }))
+        .optional(),
+})
+    .describe('Callback with results.');
+//# sourceMappingURL=asyncTranslationV2Schemas.js.map

package/dist/sdk/schemas/translation/asyncTranslationV2Schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncTranslationV2Schemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/asyncTranslationV2Schemas.ts"],"names":[],"mappings":";;;;AAAA,sDAAmB;AAEnB,uEAAoE;AACpE,2DAMgC;AAChC,2EAAwE;AAExE,mDAAoE;AAEpE,MAAM,qBAAqB,GAAG,GAAG,CAAA;AACjC,MAAM,wBAAwB,GAAG,IAAI,CAAA;AACrC,MAAM,0BAA0B,GAAG,GAAG,CAAA;AACtC,MAAM,mCAAmC,GAAG,GAAG,CAAA;AAC/C,MAAM,gCAAgC,GAAG,GAAG,CAAA;AAC5C,MAAM,wBAAwB,GAAG,EAAE,CAAA;AAEnC,MAAM,oCAAoC,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;AAE5E,QAAA,iCAAiC,GAAG,aAAC,CAAC,MAAM,CAAC;IACxD,EAAE,EAAE,oCAAoC;IACxC,OAAO,EAAE,+BAAe;IACxB,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC;CACvD,CAAC,CAAA;AAEF,MAAM,yCAAyC,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;AAEtF,QAAA,sCAAsC,GAAG,aAAC,CAAC,MAAM,CAAC;IAC7D,EAAE,EAAE,yCAAyC;IAC7C,OAAO,EAAE,aAAC;SACP,MAAM,CAAC;QACN,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mCAAmC,CAAC;KACxE,CAAC;SACD,QAAQ,EAAE;IACb,cAAc,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,QAAQ,EAAE,aAAC;SACR,KAAK,CAAC,yCAAiC,CAAC;SACxC,QAAQ,EAAE;SACV,GAAG,CAAC,gCAAgC,CAAC;SACrC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QAEpC,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,CAAA;IACzC,CAAC,EAAE,8CAA8C,CAAC;CACrD,CAAC,CAAA;AAEW,QAAA,8BAA8B,GAAG,0CAAoB,CAAC,MAAM,CAAC;IACxE,YAAY,EAAE,6BAAa;IAC3B,YAAY,EAAE,6BAAa;IAC3B,WAAW,EAAE,8CAA8B,CAAC,QAAQ,EAAE;IACtD,sBAAsB,EAAE,aAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAClD,OAAO,EAAE,8CAAsB,CAAC,QAAQ,EAAE;IAC1C,YAAY,EAAE,aAAC;SACZ,KAAK,CAAC,8CAAsC,CAAC;SAC7C,QAAQ,EAAE;SACV,GAAG,CAAC,wBAAwB,CAAC;SAC7B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QAEpC,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,CAAA;IACzC,CAAC,EAAE,8CAA8C,CAAC;CACrD,CAAC;KACC,MAAM,CAAC,GAAG,kDAAkC,CAAC;KAC7C,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;IACf,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAA;AAC3D,CAAC,EAAE,kFAAkF,CAAC,CAAA;AAE3E,QAAA,iCAAiC,GAAG,6CAA6B,CAAA;AAEjE,QAAA,kCAAkC,GAAG,aAAC;KAChD,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,kCAAkC,GAAG,aAAC;KAChD,MAAM,CAAC;IACN,mBAAmB,EAAE,aAAC,CAAC,MAAM,EAAE;IAC/B,IAAI,EAAE,aAAC,CAAC,KAAK,CACX,aAAC,CAAC,MAAM,CAAC;QACP,aAAa,EAAE,oCAAoC;QACnD,SAAS,EAAE,oCAAoC;QAC/C,aAAa,EAAE,aAAC,CAAC,MAAM,EAAE;QACzB,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE;QACvB,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC7B,CAAC,CACH;IACD,MAAM,EAAE,aAAC;SACN,KAAK,CACJ,4CAA4B,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,oCAAoC;QACnD,SAAS,EAAE,oCAAoC;QAC/C,aAAa,EAAE,aAAC,CAAC,MAAM,EAAE;QACzB,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE;KACxB,CAAC,CACH;SACA,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,wBAAwB,CAAC,CAAA"}

package/dist/sdk/schemas/translation/sharedSchemas.d.ts

@@ -0,0 +1,4 @@
+export declare const refineDifferentSourceAndTargetLang: readonly [(data: {
+    sourceLocale: string;
+    targetLocale: string;
+}) => boolean, "The sourceLocale and targetLocale must be different."];

package/dist/sdk/schemas/translation/sharedSchemas.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refineDifferentSourceAndTargetLang = void 0;
+exports.refineDifferentSourceAndTargetLang = [
+    (data) => {
+        return data.sourceLocale !== data.targetLocale;
+    },
+    'The sourceLocale and targetLocale must be different.',
+];
+//# sourceMappingURL=sharedSchemas.js.map

package/dist/sdk/schemas/translation/sharedSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/sharedSchemas.ts"],"names":[],"mappings":";;;AAAa,QAAA,kCAAkC,GAAG;IAChD,CAAC,IAAoD,EAAE,EAAE;QACvD,OAAO,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,CAAA;IAChD,CAAC;IACD,sDAAsD;CAC9C,CAAA"}