@lokalise/polyglot-sdk 6.1.0 → 8.0.0

package/dist/sdk/schemas/common/requestContextSchemas.d.ts

@@ -0,0 +1,279 @@
+import z from 'zod';
+declare const STRUCTURED_STYLE_GUIDE_SCHEMA: 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;
+}>;
+export type StructuredStyleGuide = z.infer<typeof STRUCTURED_STYLE_GUIDE_SCHEMA>;
+declare const FREEFORM_STYLE_GUIDE_SCHEMA: z.ZodObject<{
+    text: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+}, {
+    text: string;
+}>;
+export type FreeformStyleGuide = z.infer<typeof FREEFORM_STYLE_GUIDE_SCHEMA>;
+declare const STYLE_GUIDE_SCHEMA: 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;
+}>]>;
+export type StyleGuideData = z.infer<typeof STYLE_GUIDE_SCHEMA>;
+export declare function isStructuredStyleGuide(guide: Record<string, unknown>): guide is StructuredStyleGuide;
+export declare const GLOSSARY_TERM_SCHEMA: 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;
+}>;
+export declare const REQUEST_CONTEXT_SCHEMA: 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;
+}>;
+export type RequestContext = z.infer<typeof REQUEST_CONTEXT_SCHEMA>;
+export {};

package/dist/sdk/schemas/common/requestContextSchemas.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_CONTEXT_SCHEMA = exports.GLOSSARY_TERM_SCHEMA = void 0;
+exports.isStructuredStyleGuide = isStructuredStyleGuide;
+const tslib_1 = require("tslib");
+const zod_1 = tslib_1.__importDefault(require("zod"));
+const commonSchemas_1 = require("./commonSchemas");
+// ------------------------------------------
+// Style guide
+// ------------------------------------------
+const STRUCTURED_STYLE_GUIDE_SCHEMA = zod_1.default
+    .object({
+    targetAudience: zod_1.default.enum(['general', 'technical', 'non-technical']).optional(),
+    toneOfVoice: zod_1.default
+        .enum(['friendly', 'empowering', 'informative', 'supportive', 'elegant'])
+        .optional(),
+    levelOfFormality: zod_1.default.enum(['informal', 'formal', 'neutral']).optional(),
+    generalRule: zod_1.default.enum(['active-voice', 'passive-voice']).optional(),
+})
+    .describe('Structured style guide with predefined options')
+    .refine((styleGuide) => isStructuredStyleGuide(styleGuide), {
+    message: 'At least one of the fields must be defined',
+});
+const FREEFORM_STYLE_GUIDE_SCHEMA = zod_1.default
+    .object({
+    text: zod_1.default.string().describe('Styleguide text which will be directly included into the prompt'),
+})
+    .describe('Freeform style guide text');
+const STYLE_GUIDE_SCHEMA = zod_1.default
+    .union([FREEFORM_STYLE_GUIDE_SCHEMA, STRUCTURED_STYLE_GUIDE_SCHEMA])
+    .describe('General style guide to be applied to the request, can be either freeform text or structured set of choices');
+function isStructuredStyleGuide(guide) {
+    return (guide.targetAudience !== undefined ||
+        guide.toneOfVoice !== undefined ||
+        guide.levelOfFormality !== undefined ||
+        guide.generalRule !== undefined);
+}
+// ------------------------------------------
+// Glossary
+// ------------------------------------------
+exports.GLOSSARY_TERM_SCHEMA = zod_1.default
+    .object({
+    term: zod_1.default.string().min(1).describe('Term text in source language'),
+    description: zod_1.default
+        .string()
+        .min(1)
+        .describe('An explanation of your term that will help provide the context of what your term means to the translation engine e.g. `router` is in reference to `network`. This can help provide more relevant translations for your content.')
+        .optional(),
+    translatable: zod_1.default
+        .boolean()
+        .describe('Should the term be translated or preserved as-is in the target language')
+        .default(true),
+    forbidden: zod_1.default.boolean().describe('Should the term be avoided in translations').default(false),
+    caseSensitive: zod_1.default
+        .boolean()
+        .describe('Whether the term is case-sensitive. For example, acronyms like PNG or BMP can be marked as case-sensitive')
+        .default(false),
+    translations: zod_1.default
+        .array(zod_1.default.object({
+        locale: commonSchemas_1.LOCALE_SCHEMA,
+        translation: zod_1.default.string().describe('Term translation in target language').min(1),
+        description: zod_1.default
+            .string()
+            .describe('Additional explanation for the term translation')
+            .optional(),
+    }))
+        .describe('List of objects providing language-specific information about the glossary term')
+        .optional(),
+})
+    .describe('Glossary term')
+    .refine(({ translations, translatable, forbidden }) => !!translations || !translatable || forbidden, {
+    message: 'You should either provide `translations` for the term or mark it as `translatable: false` (or `forbidden: true`)',
+});
+exports.REQUEST_CONTEXT_SCHEMA = zod_1.default
+    .object({
+    description: zod_1.default
+        .string()
+        .min(1)
+        .describe('any helpful description that applies to the whole request. E.g. project description')
+        .optional(),
+    styleGuide: STYLE_GUIDE_SCHEMA.optional(),
+    glossary: zod_1.default.array(exports.GLOSSARY_TERM_SCHEMA).describe('List of glossary terms').optional(),
+})
+    .describe('Helpful translation context');
+//# sourceMappingURL=requestContextSchemas.js.map

package/dist/sdk/schemas/common/requestContextSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestContextSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/common/requestContextSchemas.ts"],"names":[],"mappings":";;;AAwCA,wDASC;;AAjDD,sDAAmB;AAEnB,mDAA+C;AAE/C,6CAA6C;AAC7C,cAAc;AACd,6CAA6C;AAE7C,MAAM,6BAA6B,GAAG,aAAC;KACpC,MAAM,CAAC;IACN,cAAc,EAAE,aAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5E,WAAW,EAAE,aAAC;SACX,IAAI,CAAC,CAAC,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;SACxE,QAAQ,EAAE;IACb,gBAAgB,EAAE,aAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtE,WAAW,EAAE,aAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE;CAClE,CAAC;KACD,QAAQ,CAAC,gDAAgD,CAAC;KAC1D,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE;IAC1D,OAAO,EAAE,4CAA4C;CACtD,CAAC,CAAA;AAIJ,MAAM,2BAA2B,GAAG,aAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iEAAiE,CAAC;CAC7F,CAAC;KACD,QAAQ,CAAC,2BAA2B,CAAC,CAAA;AAIxC,MAAM,kBAAkB,GAAG,aAAC;KACzB,KAAK,CAAC,CAAC,2BAA2B,EAAE,6BAA6B,CAAC,CAAC;KACnE,QAAQ,CACP,4GAA4G,CAC7G,CAAA;AAIH,SAAgB,sBAAsB,CACpC,KAA8B;IAE9B,OAAO,CACL,KAAK,CAAC,cAAc,KAAK,SAAS;QAClC,KAAK,CAAC,WAAW,KAAK,SAAS;QAC/B,KAAK,CAAC,gBAAgB,KAAK,SAAS;QACpC,KAAK,CAAC,WAAW,KAAK,SAAS,CAChC,CAAA;AACH,CAAC;AAED,6CAA6C;AAC7C,WAAW;AACX,6CAA6C;AAEhC,QAAA,oBAAoB,GAAG,aAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAChE,WAAW,EAAE,aAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,iOAAiO,CAClO;SACA,QAAQ,EAAE;IACb,YAAY,EAAE,aAAC;SACZ,OAAO,EAAE;SACT,QAAQ,CAAC,yEAAyE,CAAC;SACnF,OAAO,CAAC,IAAI,CAAC;IAChB,SAAS,EAAE,aAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5F,aAAa,EAAE,aAAC;SACb,OAAO,EAAE;SACT,QAAQ,CACP,2GAA2G,CAC5G;SACA,OAAO,CAAC,KAAK,CAAC;IACjB,YAAY,EAAE,aAAC;SACZ,KAAK,CACJ,aAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,6BAAa;QACrB,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9E,WAAW,EAAE,aAAC;aACX,MAAM,EAAE;aACR,QAAQ,CAAC,iDAAiD,CAAC;aAC3D,QAAQ,EAAE;KACd,CAAC,CACH;SACA,QAAQ,CAAC,iFAAiF,CAAC;SAC3F,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,eAAe,CAAC;KACzB,MAAM,CACL,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,YAAY,IAAI,SAAS,EAC3F;IACE,OAAO,EACL,kHAAkH;CACrH,CACF,CAAA;AAEU,QAAA,sBAAsB,GAAG,aAAC;KACpC,MAAM,CAAC;IACN,WAAW,EAAE,aAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,qFAAqF,CACtF;SACA,QAAQ,EAAE;IACb,UAAU,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,aAAC,CAAC,KAAK,CAAC,4BAAoB,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;CACtF,CAAC;KACD,QAAQ,CAAC,6BAA6B,CAAC,CAAA"}