npm - @lokalise/polyglot-sdk - Versions diffs - 8.0.0 → 9.0.0 - Mend

@lokalise/polyglot-sdk 8.0.0 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

package/dist/sdk/schemas/lqa/lqaAsyncV1Schemas.d.ts ADDED Viewed

@@ -0,0 +1,646 @@
+import z from 'zod';
+export declare const LQA_ASYNC_V1_BODY_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+    originCorrelationId: z.ZodString;
+    ownerId: z.ZodString;
+    tenantId: z.ZodString;
+    callbackUrl: z.ZodString;
+    callbackToken: z.ZodString;
+}, {
+    sourceLocale: z.ZodEffects<z.ZodString, string, string>;
+    integration: z.ZodOptional<z.ZodNativeEnum<{
+        readonly CLAUDE: "Claude";
+        readonly CHAT_GPT4: "ChatGPT-4";
+        readonly GEMINI: "Gemini";
+    }>>;
+    context: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        styleGuide: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            text: string;
+        }, {
+            text: string;
+        }>, z.ZodEffects<z.ZodObject<{
+            targetAudience: z.ZodOptional<z.ZodEnum<["general", "technical", "non-technical"]>>;
+            toneOfVoice: z.ZodOptional<z.ZodEnum<["friendly", "empowering", "informative", "supportive", "elegant"]>>;
+            levelOfFormality: z.ZodOptional<z.ZodEnum<["informal", "formal", "neutral"]>>;
+            generalRule: z.ZodOptional<z.ZodEnum<["active-voice", "passive-voice"]>>;
+        }, "strip", z.ZodTypeAny, {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        }, {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        }>, {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        }, {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        }>]>>;
+        glossary: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
+            term: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            translatable: z.ZodDefault<z.ZodBoolean>;
+            forbidden: z.ZodDefault<z.ZodBoolean>;
+            caseSensitive: z.ZodDefault<z.ZodBoolean>;
+            translations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                locale: z.ZodEffects<z.ZodString, string, string>;
+                translation: z.ZodString;
+                description: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }, {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            term: string;
+            translatable: boolean;
+            forbidden: boolean;
+            caseSensitive: boolean;
+            description?: string | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }, {
+            term: string;
+            description?: string | undefined;
+            translatable?: boolean | undefined;
+            forbidden?: boolean | undefined;
+            caseSensitive?: boolean | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }>, {
+            term: string;
+            translatable: boolean;
+            forbidden: boolean;
+            caseSensitive: boolean;
+            description?: string | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }, {
+            term: string;
+            description?: string | undefined;
+            translatable?: boolean | undefined;
+            forbidden?: boolean | undefined;
+            caseSensitive?: boolean | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+        styleGuide?: {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        } | {
+            text: string;
+        } | undefined;
+        glossary?: {
+            term: string;
+            translatable: boolean;
+            forbidden: boolean;
+            caseSensitive: boolean;
+            description?: string | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    }, {
+        description?: string | undefined;
+        styleGuide?: {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        } | {
+            text: string;
+        } | undefined;
+        glossary?: {
+            term: string;
+            description?: string | undefined;
+            translatable?: boolean | undefined;
+            forbidden?: boolean | undefined;
+            caseSensitive?: boolean | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    }>>;
+    contentUnits: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        context: z.ZodOptional<z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            description?: string | undefined;
+        }, {
+            description?: string | undefined;
+        }>>;
+        segments: z.ZodArray<z.ZodObject<{
+            sourceValue: z.ZodString;
+            translations: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                locale: z.ZodEffects<z.ZodString, string, string>;
+                value: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                locale: string;
+                id: string;
+            }, {
+                value: string;
+                locale: string;
+                id: string;
+            }>, "atleastone">;
+            tmMatch: z.ZodOptional<z.ZodObject<{
+                sourceValue: z.ZodString;
+                translatedValue: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                sourceValue: string;
+                translatedValue: string;
+            }, {
+                sourceValue: string;
+                translatedValue: string;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, {
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }>, "atleastone">;
+        characterLimit: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        segments: [{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, ...{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }[]];
+        context?: {
+            description?: string | undefined;
+        } | undefined;
+        characterLimit?: number | undefined;
+    }, {
+        id: string;
+        segments: [{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, ...{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }[]];
+        context?: {
+            description?: string | undefined;
+        } | undefined;
+        characterLimit?: number | undefined;
+    }>, "atleastone">;
+}>, "strip", z.ZodTypeAny, {
+    originCorrelationId: string;
+    ownerId: string;
+    tenantId: string;
+    callbackUrl: string;
+    callbackToken: string;
+    sourceLocale: string;
+    contentUnits: [{
+        id: string;
+        segments: [{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, ...{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }[]];
+        context?: {
+            description?: string | undefined;
+        } | undefined;
+        characterLimit?: number | undefined;
+    }, ...{
+        id: string;
+        segments: [{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, ...{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }[]];
+        context?: {
+            description?: string | undefined;
+        } | undefined;
+        characterLimit?: number | undefined;
+    }[]];
+    context?: {
+        description?: string | undefined;
+        styleGuide?: {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        } | {
+            text: string;
+        } | undefined;
+        glossary?: {
+            term: string;
+            translatable: boolean;
+            forbidden: boolean;
+            caseSensitive: boolean;
+            description?: string | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    } | undefined;
+    integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
+}, {
+    originCorrelationId: string;
+    ownerId: string;
+    tenantId: string;
+    callbackUrl: string;
+    callbackToken: string;
+    sourceLocale: string;
+    contentUnits: [{
+        id: string;
+        segments: [{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, ...{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }[]];
+        context?: {
+            description?: string | undefined;
+        } | undefined;
+        characterLimit?: number | undefined;
+    }, ...{
+        id: string;
+        segments: [{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }, ...{
+            sourceValue: string;
+            translations: [{
+                value: string;
+                locale: string;
+                id: string;
+            }, ...{
+                value: string;
+                locale: string;
+                id: string;
+            }[]];
+            tmMatch?: {
+                sourceValue: string;
+                translatedValue: string;
+            } | undefined;
+        }[]];
+        context?: {
+            description?: string | undefined;
+        } | undefined;
+        characterLimit?: number | undefined;
+    }[]];
+    context?: {
+        description?: string | undefined;
+        styleGuide?: {
+            targetAudience?: "general" | "technical" | "non-technical" | undefined;
+            toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
+            levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
+            generalRule?: "active-voice" | "passive-voice" | undefined;
+        } | {
+            text: string;
+        } | undefined;
+        glossary?: {
+            term: string;
+            description?: string | undefined;
+            translatable?: boolean | undefined;
+            forbidden?: boolean | undefined;
+            caseSensitive?: boolean | undefined;
+            translations?: {
+                locale: string;
+                translation: string;
+                description?: string | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    } | undefined;
+    integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
+}>;
+export declare const LQA_ASYNC_V1_HEADERS_SCHEMA: z.ZodObject<{
+    'x-fake-processing': z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
+}, "strip", z.ZodTypeAny, {
+    'x-fake-processing'?: boolean | undefined;
+}, {
+    'x-fake-processing'?: unknown;
+}>;
+export declare const LQA_ASYNC_V1_RESPONSE_SCHEMA: z.ZodObject<{
+    requestId: z.ZodString;
+    expectedAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    expectedAt: string;
+}, {
+    requestId: string;
+    expectedAt: string;
+}>;
+export declare const LQA_ASYNC_V1_CALLBACK_SCHEMA: z.ZodObject<{
+    originCorrelationId: z.ZodString;
+    data: z.ZodArray<z.ZodObject<{
+        contentUnitId: z.ZodString;
+        translationId: z.ZodString;
+        suggestion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        issues: z.ZodArray<z.ZodObject<{
+            category: z.ZodNativeEnum<{
+                readonly ACCURACY: "accuracy";
+                readonly FLUENCY: "fluency";
+                readonly TERMINOLOGY: "terminology";
+                readonly LOCALE_CONVENTION: "locale convention";
+                readonly STYLE: "style";
+                readonly CONSISTENCY: "consistency";
+                readonly COHERENCE: "coherence";
+                readonly DESIGN: "design";
+                readonly MARKUP: "markup";
+                readonly INTERNATIONALIZATION: "internationalization";
+                readonly VERITY: "verity";
+            }>;
+            severity: z.ZodNativeEnum<{
+                readonly NEUTRAL: "neutral";
+                readonly MINOR: "minor";
+                readonly MAJOR: "major";
+                readonly CRITICAL: "critical";
+            }>;
+            comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            category: "accuracy" | "fluency" | "terminology" | "locale convention" | "style" | "consistency" | "coherence" | "design" | "markup" | "internationalization" | "verity";
+            severity: "neutral" | "minor" | "major" | "critical";
+            comment?: string | null | undefined;
+        }, {
+            category: "accuracy" | "fluency" | "terminology" | "locale convention" | "style" | "consistency" | "coherence" | "design" | "markup" | "internationalization" | "verity";
+            severity: "neutral" | "minor" | "major" | "critical";
+            comment?: string | null | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        contentUnitId: string;
+        translationId: string;
+        issues: {
+            category: "accuracy" | "fluency" | "terminology" | "locale convention" | "style" | "consistency" | "coherence" | "design" | "markup" | "internationalization" | "verity";
+            severity: "neutral" | "minor" | "major" | "critical";
+            comment?: string | null | undefined;
+        }[];
+        suggestion?: string | null | undefined;
+    }, {
+        contentUnitId: string;
+        translationId: string;
+        issues: {
+            category: "accuracy" | "fluency" | "terminology" | "locale convention" | "style" | "consistency" | "coherence" | "design" | "markup" | "internationalization" | "verity";
+            severity: "neutral" | "minor" | "major" | "critical";
+            comment?: string | null | undefined;
+        }[];
+        suggestion?: string | null | undefined;
+    }>, "many">;
+    errors: z.ZodOptional<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, {
+        contentUnitId: z.ZodString;
+        translationId: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        contentUnitId: string;
+        translationId: string;
+        details?: Record<string, unknown> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        contentUnitId: string;
+        translationId: string;
+        details?: Record<string, unknown> | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    originCorrelationId: string;
+    data: {
+        contentUnitId: string;
+        translationId: string;
+        issues: {
+            category: "accuracy" | "fluency" | "terminology" | "locale convention" | "style" | "consistency" | "coherence" | "design" | "markup" | "internationalization" | "verity";
+            severity: "neutral" | "minor" | "major" | "critical";
+            comment?: string | null | undefined;
+        }[];
+        suggestion?: string | null | undefined;
+    }[];
+    errors?: {
+        message: string;
+        errorCode: string;
+        contentUnitId: string;
+        translationId: string;
+        details?: Record<string, unknown> | undefined;
+    }[] | undefined;
+}, {
+    originCorrelationId: string;
+    data: {
+        contentUnitId: string;
+        translationId: string;
+        issues: {
+            category: "accuracy" | "fluency" | "terminology" | "locale convention" | "style" | "consistency" | "coherence" | "design" | "markup" | "internationalization" | "verity";
+            severity: "neutral" | "minor" | "major" | "critical";
+            comment?: string | null | undefined;
+        }[];
+        suggestion?: string | null | undefined;
+    }[];
+    errors?: {
+        message: string;
+        errorCode: string;
+        contentUnitId: string;
+        translationId: string;
+        details?: Record<string, unknown> | undefined;
+    }[] | undefined;
+}>;
+export type LqaAsyncV1Body = z.infer<typeof LQA_ASYNC_V1_BODY_SCHEMA>;
+export type LqaAsyncV1Headers = z.infer<typeof LQA_ASYNC_V1_HEADERS_SCHEMA>;
+export type LqaAsyncV1Response = z.infer<typeof LQA_ASYNC_V1_RESPONSE_SCHEMA>;
+export type LqaAsyncV1CallbackBody = z.infer<typeof LQA_ASYNC_V1_CALLBACK_SCHEMA>;