@lokalise/polyglot-sdk 24.6.0 → 24.7.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './sdk/contracts/contextSufficiencyContracts.ts';
 export * from './sdk/contracts/reviewContracts.ts';
+export * from './sdk/contracts/shadowReplayContracts.ts';
 export * from './sdk/contracts/translationContracts.ts';
 export { PolyglotError } from './sdk/errors/PolyglotError.ts';
 export * from './sdk/helpers/htmlEscaping.ts';
@@ -18,6 +19,7 @@ export * from './sdk/schemas/context-sufficiency/contextSufficiencySyncSchemas.t
 export * from './sdk/schemas/lqa/commonSchemas.ts';
 export * from './sdk/schemas/lqa/lqaAsyncSchemas.ts';
 export * from './sdk/schemas/lqa/lqaSyncSchemas.ts';
+export * from './sdk/schemas/shadow-replay/manualReplaySchemas.ts';
 export * from './sdk/schemas/translation/generateVariants.ts';
 export * from './sdk/schemas/translation/rewriteTextSchemas.ts';
 export * from './sdk/schemas/translation/sharedSchemas.ts';

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./sdk/contracts/contextSufficiencyContracts.js";
 export * from "./sdk/contracts/reviewContracts.js";
+export * from "./sdk/contracts/shadowReplayContracts.js";
 export * from "./sdk/contracts/translationContracts.js";
 export { PolyglotError } from "./sdk/errors/PolyglotError.js";
 export * from "./sdk/helpers/htmlEscaping.js";
@@ -17,6 +18,7 @@ export * from "./sdk/schemas/context-sufficiency/contextSufficiencySyncSchemas.j
 export * from "./sdk/schemas/lqa/commonSchemas.js";
 export * from "./sdk/schemas/lqa/lqaAsyncSchemas.js";
 export * from "./sdk/schemas/lqa/lqaSyncSchemas.js";
+export * from "./sdk/schemas/shadow-replay/manualReplaySchemas.js";
 export * from "./sdk/schemas/translation/generateVariants.js";
 export * from "./sdk/schemas/translation/rewriteTextSchemas.js";
 export * from "./sdk/schemas/translation/sharedSchemas.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gDAAgD,CAAA;AAC9D,cAAc,oCAAoC,CAAA;AAClD,cAAc,yCAAyC,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAC7D,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA;AAC/D,cAAc,8CAA8C,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,uCAAuC,CAAA;AACrD,cAAc,sCAAsC,CAAA;AACpD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,2CAA2C,CAAA;AASzD,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,mDAAmD,CAAA;AAC1D,cAAc,oEAAoE,CAAA;AAClF,cAAc,oCAAoC,CAAA;AAClD,cAAc,sCAAsC,CAAA;AACpD,cAAc,qCAAqC,CAAA;AACnD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA;AAC/D,cAAc,4CAA4C,CAAA;AAC1D,cAAc,oDAAoD,CAAA;AAClE,cAAc,mDAAmD,CAAA;AACjE,cAAc,0DAA0D,CAAA;AAExE,OAAO,EACL,yBAAyB,EACzB,yBAAyB,IAAI,6BAA6B,GAC3D,MAAM,+CAA+C,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gDAAgD,CAAA;AAC9D,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,yCAAyC,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAC7D,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA;AAC/D,cAAc,8CAA8C,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,uCAAuC,CAAA;AACrD,cAAc,sCAAsC,CAAA;AACpD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,2CAA2C,CAAA;AASzD,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,mDAAmD,CAAA;AAC1D,cAAc,oEAAoE,CAAA;AAClF,cAAc,oCAAoC,CAAA;AAClD,cAAc,sCAAsC,CAAA;AACpD,cAAc,qCAAqC,CAAA;AACnD,cAAc,oDAAoD,CAAA;AAClE,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA;AAC/D,cAAc,4CAA4C,CAAA;AAC1D,cAAc,oDAAoD,CAAA;AAClE,cAAc,mDAAmD,CAAA;AACjE,cAAc,0DAA0D,CAAA;AAExE,OAAO,EACL,yBAAyB,EACzB,yBAAyB,IAAI,6BAA6B,GAC3D,MAAM,+CAA+C,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA"}

package/dist/sdk/contracts/shadowReplayContracts.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Internal endpoint to manually trigger a shadow replay for a given primary request. A manual
+ * trigger is an explicit operator selection, so it bypasses sampling and the global shadow-replay
+ * enable flag.
+ */
+export declare const manualReplayContract: {
+    readonly method: "post";
+    readonly pathResolver: () => string;
+    readonly requestBodySchema: import("zod/v4").ZodObject<{
+        requestId: import("zod/v4").ZodUUID;
+        requestType: import("zod/v4").ZodEnum<{
+            readonly TRANSLATION_SYNC: "TRANSLATION_SYNC";
+            readonly TRANSLATION_ASYNC: "TRANSLATION_ASYNC";
+        }>;
+        overrides: import("zod/v4").ZodOptional<import("zod/v4").ZodObject<{
+            integration: import("zod/v4").ZodOptional<import("zod/v4").ZodEnum<{
+                readonly FAKE: "Fake";
+                readonly CLAUDE: "Claude";
+                readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+                readonly GPT: "GPT";
+                readonly GEMINI: "Gemini";
+                readonly DEEPL: "DeepL";
+                readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+            }>>;
+            modelName: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
+        }, import("zod/v4/core").$strip>>;
+    }, import("zod/v4/core").$strip>;
+    readonly summary: "Trigger shadow replay (internal)";
+    readonly description: "Manually triggers a shadow replay for an existing primary request. Internal use only.";
+    readonly tags: readonly ["Shadow Replay (internal)"];
+    readonly responsesByStatusCode: {
+        readonly 202: import("zod/v4").ZodObject<{
+            replayId: import("zod/v4").ZodUUID;
+        }, import("zod/v4/core").$strip>;
+        readonly 400: import("zod/v4").ZodObject<{
+            message: import("zod/v4").ZodString;
+            errorCode: import("zod/v4").ZodString;
+            details: import("zod/v4").ZodOptional<import("zod/v4").ZodRecord<import("zod/v4").ZodString, import("zod/v4").ZodUnknown>>;
+        }, import("zod/v4/core").$strip>;
+        readonly 404: import("zod/v4").ZodObject<{
+            message: import("zod/v4").ZodString;
+            errorCode: import("zod/v4").ZodString;
+            details: import("zod/v4").ZodOptional<import("zod/v4").ZodRecord<import("zod/v4").ZodString, import("zod/v4").ZodUnknown>>;
+        }, import("zod/v4/core").$strip>;
+    };
+};

package/dist/sdk/contracts/shadowReplayContracts.js

@@ -0,0 +1,22 @@
+import { defineApiContract } from '@lokalise/api-contracts';
+import { COMMON_ERROR_RESPONSE_SCHEMA } from "../schemas/common/commonSchemas.js";
+import { MANUAL_REPLAY_BODY_SCHEMA, MANUAL_REPLAY_RESPONSE_SCHEMA, } from "../schemas/shadow-replay/manualReplaySchemas.js";
+/**
+ * Internal endpoint to manually trigger a shadow replay for a given primary request. A manual
+ * trigger is an explicit operator selection, so it bypasses sampling and the global shadow-replay
+ * enable flag.
+ */
+export const manualReplayContract = defineApiContract({
+    method: 'post',
+    pathResolver: () => '/v1/request-replay',
+    requestBodySchema: MANUAL_REPLAY_BODY_SCHEMA,
+    summary: 'Trigger shadow replay (internal)',
+    description: 'Manually triggers a shadow replay for an existing primary request. Internal use only.',
+    tags: ['Shadow Replay (internal)'],
+    responsesByStatusCode: {
+        202: MANUAL_REPLAY_RESPONSE_SCHEMA,
+        400: COMMON_ERROR_RESPONSE_SCHEMA,
+        404: COMMON_ERROR_RESPONSE_SCHEMA,
+    },
+});
+//# sourceMappingURL=shadowReplayContracts.js.map

package/dist/sdk/contracts/shadowReplayContracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shadowReplayContracts.js","sourceRoot":"","sources":["../../../src/sdk/contracts/shadowReplayContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAA;AACjF,OAAO,EACL,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,iDAAiD,CAAA;AAExD;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,oBAAoB;IACxC,iBAAiB,EAAE,yBAAyB;IAC5C,OAAO,EAAE,kCAAkC;IAC3C,WAAW,EACT,uFAAuF;IACzF,IAAI,EAAE,CAAC,0BAA0B,CAAC;IAClC,qBAAqB,EAAE;QACrB,GAAG,EAAE,6BAA6B;QAClC,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;CACF,CAAC,CAAA"}

package/dist/sdk/schemas/shadow-replay/manualReplaySchemas.d.ts

@@ -0,0 +1,52 @@
+import z from 'zod/v4';
+import type { ObjectValues } from '../../types/common.ts';
+/**
+ * Primary request types a manual replay can target. Restricted to translation operations: the
+ * shadow replay executor only knows how to re-run translation requests today, so accepting LQA
+ * task types would create replays no worker could fulfil. Widen this once LQA replay lands.
+ */
+export declare const ManualReplayRequestTypeEnum: {
+    readonly TRANSLATION_SYNC: "TRANSLATION_SYNC";
+    readonly TRANSLATION_ASYNC: "TRANSLATION_ASYNC";
+};
+export type ManualReplayRequestTypeEnum = ObjectValues<typeof ManualReplayRequestTypeEnum>;
+export declare const MANUAL_REPLAY_REQUEST_TYPE_SCHEMA: z.ZodEnum<{
+    readonly TRANSLATION_SYNC: "TRANSLATION_SYNC";
+    readonly TRANSLATION_ASYNC: "TRANSLATION_ASYNC";
+}>;
+export declare const MANUAL_REPLAY_OVERRIDES_SCHEMA: z.ZodObject<{
+    integration: z.ZodOptional<z.ZodEnum<{
+        readonly FAKE: "Fake";
+        readonly CLAUDE: "Claude";
+        readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+        readonly GPT: "GPT";
+        readonly GEMINI: "Gemini";
+        readonly DEEPL: "DeepL";
+        readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+    }>>;
+    modelName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const MANUAL_REPLAY_BODY_SCHEMA: z.ZodObject<{
+    requestId: z.ZodUUID;
+    requestType: z.ZodEnum<{
+        readonly TRANSLATION_SYNC: "TRANSLATION_SYNC";
+        readonly TRANSLATION_ASYNC: "TRANSLATION_ASYNC";
+    }>;
+    overrides: z.ZodOptional<z.ZodObject<{
+        integration: z.ZodOptional<z.ZodEnum<{
+            readonly FAKE: "Fake";
+            readonly CLAUDE: "Claude";
+            readonly CLAUDE_BEDROCK: "Claude-Bedrock";
+            readonly GPT: "GPT";
+            readonly GEMINI: "Gemini";
+            readonly DEEPL: "DeepL";
+            readonly GOOGLE_TRANSLATE: "GoogleTranslate";
+        }>>;
+        modelName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const MANUAL_REPLAY_RESPONSE_SCHEMA: z.ZodObject<{
+    replayId: z.ZodUUID;
+}, z.core.$strip>;
+export type ManualReplayBody = z.infer<typeof MANUAL_REPLAY_BODY_SCHEMA>;
+export type ManualReplayResponse = z.infer<typeof MANUAL_REPLAY_RESPONSE_SCHEMA>;

package/dist/sdk/schemas/shadow-replay/manualReplaySchemas.js

@@ -0,0 +1,36 @@
+import z from 'zod/v4';
+import { IntegrationEngineEnum } from "../common/commonSchemas.js";
+/**
+ * Primary request types a manual replay can target. Restricted to translation operations: the
+ * shadow replay executor only knows how to re-run translation requests today, so accepting LQA
+ * task types would create replays no worker could fulfil. Widen this once LQA replay lands.
+ */
+export const ManualReplayRequestTypeEnum = {
+    TRANSLATION_SYNC: 'TRANSLATION_SYNC',
+    TRANSLATION_ASYNC: 'TRANSLATION_ASYNC',
+};
+export const MANUAL_REPLAY_REQUEST_TYPE_SCHEMA = z
+    .enum(ManualReplayRequestTypeEnum)
+    .describe('Type of the primary request to replay (translation only)');
+export const MANUAL_REPLAY_OVERRIDES_SCHEMA = z
+    .object({
+    integration: z
+        .enum(IntegrationEngineEnum)
+        .optional()
+        .describe('Force this integration for every replayed segment instead of the originals'),
+    modelName: z.string().min(1).optional().describe('Force this model name for the replay'),
+})
+    .describe('Optional overrides applied to the whole replay. Omit for a faithful replay.');
+export const MANUAL_REPLAY_BODY_SCHEMA = z
+    .object({
+    requestId: z.uuid().describe('Id of the primary request to replay'),
+    requestType: MANUAL_REPLAY_REQUEST_TYPE_SCHEMA,
+    overrides: MANUAL_REPLAY_OVERRIDES_SCHEMA.optional(),
+})
+    .describe('Manual shadow replay trigger');
+export const MANUAL_REPLAY_RESPONSE_SCHEMA = z
+    .object({
+    replayId: z.uuid().describe('Id of the created shadow replay'),
+})
+    .describe('Created shadow replay');
+//# sourceMappingURL=manualReplaySchemas.js.map

package/dist/sdk/schemas/shadow-replay/manualReplaySchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manualReplaySchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/shadow-replay/manualReplaySchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAA;AAEtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAElE;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;CAC9B,CAAA;AAGV,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC;KAC/C,IAAI,CAAC,2BAA2B,CAAC;KACjC,QAAQ,CAAC,0DAA0D,CAAC,CAAA;AAEvE,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,qBAAqB,CAAC;SAC3B,QAAQ,EAAE;SACV,QAAQ,CAAC,4EAA4E,CAAC;IACzF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;CACzF,CAAC;KACD,QAAQ,CAAC,6EAA6E,CAAC,CAAA;AAE1F,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IACnE,WAAW,EAAE,iCAAiC;IAC9C,SAAS,EAAE,8BAA8B,CAAC,QAAQ,EAAE;CACrD,CAAC;KACD,QAAQ,CAAC,8BAA8B,CAAC,CAAA;AAE3C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC3C,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;CAC/D,CAAC;KACD,QAAQ,CAAC,uBAAuB,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/polyglot-sdk",
-  "version": "24.6.0",
+  "version": "24.7.0",
   "author": {
     "name": "Lokalise",
     "url": "https://lokalise.com/"
@@ -30,7 +30,7 @@
   },
   "dependencies": {
     "@lokalise/api-contracts": "^6.13.0",
-    "@lokalise/backend-http-client": "^10.3.0",
+    "@lokalise/backend-http-client": "^11.2.0",
     "@lokalise/fastify-extras": "^31.0.0",
     "@lokalise/id-utils": "^3.0.1",
     "@lokalise/node-core": "^14.1.0",
@@ -39,20 +39,20 @@
     "html-escaper": "^3.0.3",
     "parse-sse": "^0.1.0",
     "pino": "^10.3.1",
-    "undici": "^8.4.1",
+    "undici": "^8.5.0",
     "undici-retry": "^7.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.4.16",
+    "@biomejs/biome": "^2.5.0",
     "@lokalise/biome-config": "^3.1.1",
     "@lokalise/tsconfig": "^4.0.0",
     "@types/html-escaper": "^3.0.4",
-    "@types/node": "^25.9.2",
-    "@vitest/coverage-v8": "^4.1.8",
+    "@types/node": "^25.9.3",
+    "@vitest/coverage-v8": "^4.1.9",
     "mockttp": "^4.4.2",
     "rimraf": "^6.1.3",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.8",
+    "vitest": "^4.1.9",
     "zod": "^4.4.3"
   },
   "peerDependencies": {