@lokalise/content-conversion-schemas 5.5.0 → 5.6.0

package/dist/api/textUnit.d.ts

@@ -0,0 +1,202 @@
+import { z } from 'zod/v4';
+export declare const TEXT_SEGMENT_SCHEMA: z.ZodString;
+export declare const TextCodeTypeEnum: {
+    readonly OPENING: "OPENING";
+    readonly CLOSING: "CLOSING";
+    readonly PLACEHOLDER: "PLACEHOLDER";
+};
+export type TextCodeType = (typeof TextCodeTypeEnum)[keyof typeof TextCodeTypeEnum];
+export declare const TEXT_CODE_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<{
+        readonly OPENING: "OPENING";
+        readonly CLOSING: "CLOSING";
+        readonly PLACEHOLDER: "PLACEHOLDER";
+    }>;
+    value: z.ZodString;
+    attributes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parser: z.ZodDefault<z.ZodLiteral<"okapi">>;
+}, z.core.$strip>;
+export declare const TEXT_UNIT_SOURCE_SCHEMA: z.ZodObject<{
+    textCodes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<{
+            readonly OPENING: "OPENING";
+            readonly CLOSING: "CLOSING";
+            readonly PLACEHOLDER: "PLACEHOLDER";
+        }>;
+        value: z.ZodString;
+        attributes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        parser: z.ZodDefault<z.ZodLiteral<"okapi">>;
+    }, z.core.$strip>>>>;
+    hasBeenSegmented: z.ZodBoolean;
+    segments: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const TEXT_UNIT_TARGET_SCHEMA: z.ZodObject<{
+    hasBeenSegmented: z.ZodBoolean;
+    segments: z.ZodArray<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodObject<{
+        pptxAttributes: z.ZodOptional<z.ZodObject<{
+            slideNumber: z.ZodNumber;
+            slideType: z.ZodEnum<{
+                readonly LAYOUT: "LAYOUT";
+                readonly NOTES: "NOTES";
+                readonly MASTER_NOTES: "MASTER_NOTES";
+                readonly SLIDE: "SLIDE";
+                readonly MASTER_SLIDE: "MASTER_SLIDE";
+                readonly CHART: "CHART";
+                readonly UNKNOWN: "UNKNOWN";
+            }>;
+        }, z.core.$strip>>;
+        xcstrings: z.ZodOptional<z.ZodObject<{
+            state: z.ZodOptional<z.ZodString>;
+            shouldTranslate: z.ZodOptional<z.ZodBoolean>;
+            extractionState: z.ZodOptional<z.ZodString>;
+            localizationType: z.ZodEnum<{
+                readonly STRING_UNIT: "STRING_UNIT";
+                readonly SUBSTITUTIONS: "SUBSTITUTIONS";
+                readonly PLURAL_VARIATION: "PLURAL_VARIATION";
+                readonly DEVICE_VARIATION: "DEVICE_VARIATION";
+                readonly DEVICE_PLURAL_VARIATION: "DEVICE_PLURAL_VARIATION";
+            }>;
+            keyPath: z.ZodString;
+            device: z.ZodOptional<z.ZodEnum<{
+                readonly MAC: "MAC";
+                readonly IPHONE: "IPHONE";
+                readonly APPLE_WATCH: "APPLE_WATCH";
+                readonly IPAD: "IPAD";
+                readonly OTHER: "OTHER";
+            }>>;
+            pluralForm: z.ZodOptional<z.ZodEnum<{
+                readonly ZERO: "ZERO";
+                readonly ONE: "ONE";
+                readonly TWO: "TWO";
+                readonly FEW: "FEW";
+                readonly MANY: "MANY";
+                readonly OTHER: "OTHER";
+            }>>;
+            formatSpecifier: z.ZodOptional<z.ZodString>;
+            argNum: z.ZodOptional<z.ZodNumber>;
+            isPlural: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const TEXT_UNIT_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    isTranslatable: z.ZodBoolean;
+    source: z.ZodObject<{
+        textCodes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodEnum<{
+                readonly OPENING: "OPENING";
+                readonly CLOSING: "CLOSING";
+                readonly PLACEHOLDER: "PLACEHOLDER";
+            }>;
+            value: z.ZodString;
+            attributes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            parser: z.ZodDefault<z.ZodLiteral<"okapi">>;
+        }, z.core.$strip>>>>;
+        hasBeenSegmented: z.ZodBoolean;
+        segments: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+    targets: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        hasBeenSegmented: z.ZodBoolean;
+        segments: z.ZodArray<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodObject<{
+            pptxAttributes: z.ZodOptional<z.ZodObject<{
+                slideNumber: z.ZodNumber;
+                slideType: z.ZodEnum<{
+                    readonly LAYOUT: "LAYOUT";
+                    readonly NOTES: "NOTES";
+                    readonly MASTER_NOTES: "MASTER_NOTES";
+                    readonly SLIDE: "SLIDE";
+                    readonly MASTER_SLIDE: "MASTER_SLIDE";
+                    readonly CHART: "CHART";
+                    readonly UNKNOWN: "UNKNOWN";
+                }>;
+            }, z.core.$strip>>;
+            xcstrings: z.ZodOptional<z.ZodObject<{
+                state: z.ZodOptional<z.ZodString>;
+                shouldTranslate: z.ZodOptional<z.ZodBoolean>;
+                extractionState: z.ZodOptional<z.ZodString>;
+                localizationType: z.ZodEnum<{
+                    readonly STRING_UNIT: "STRING_UNIT";
+                    readonly SUBSTITUTIONS: "SUBSTITUTIONS";
+                    readonly PLURAL_VARIATION: "PLURAL_VARIATION";
+                    readonly DEVICE_VARIATION: "DEVICE_VARIATION";
+                    readonly DEVICE_PLURAL_VARIATION: "DEVICE_PLURAL_VARIATION";
+                }>;
+                keyPath: z.ZodString;
+                device: z.ZodOptional<z.ZodEnum<{
+                    readonly MAC: "MAC";
+                    readonly IPHONE: "IPHONE";
+                    readonly APPLE_WATCH: "APPLE_WATCH";
+                    readonly IPAD: "IPAD";
+                    readonly OTHER: "OTHER";
+                }>>;
+                pluralForm: z.ZodOptional<z.ZodEnum<{
+                    readonly ZERO: "ZERO";
+                    readonly ONE: "ONE";
+                    readonly TWO: "TWO";
+                    readonly FEW: "FEW";
+                    readonly MANY: "MANY";
+                    readonly OTHER: "OTHER";
+                }>>;
+                formatSpecifier: z.ZodOptional<z.ZodString>;
+                argNum: z.ZodOptional<z.ZodNumber>;
+                isPlural: z.ZodBoolean;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    metadata: z.ZodOptional<z.ZodObject<{
+        pptxAttributes: z.ZodOptional<z.ZodObject<{
+            slideNumber: z.ZodNumber;
+            slideType: z.ZodEnum<{
+                readonly LAYOUT: "LAYOUT";
+                readonly NOTES: "NOTES";
+                readonly MASTER_NOTES: "MASTER_NOTES";
+                readonly SLIDE: "SLIDE";
+                readonly MASTER_SLIDE: "MASTER_SLIDE";
+                readonly CHART: "CHART";
+                readonly UNKNOWN: "UNKNOWN";
+            }>;
+        }, z.core.$strip>>;
+        xcstrings: z.ZodOptional<z.ZodObject<{
+            state: z.ZodOptional<z.ZodString>;
+            shouldTranslate: z.ZodOptional<z.ZodBoolean>;
+            extractionState: z.ZodOptional<z.ZodString>;
+            localizationType: z.ZodEnum<{
+                readonly STRING_UNIT: "STRING_UNIT";
+                readonly SUBSTITUTIONS: "SUBSTITUTIONS";
+                readonly PLURAL_VARIATION: "PLURAL_VARIATION";
+                readonly DEVICE_VARIATION: "DEVICE_VARIATION";
+                readonly DEVICE_PLURAL_VARIATION: "DEVICE_PLURAL_VARIATION";
+            }>;
+            keyPath: z.ZodString;
+            device: z.ZodOptional<z.ZodEnum<{
+                readonly MAC: "MAC";
+                readonly IPHONE: "IPHONE";
+                readonly APPLE_WATCH: "APPLE_WATCH";
+                readonly IPAD: "IPAD";
+                readonly OTHER: "OTHER";
+            }>>;
+            pluralForm: z.ZodOptional<z.ZodEnum<{
+                readonly ZERO: "ZERO";
+                readonly ONE: "ONE";
+                readonly TWO: "TWO";
+                readonly FEW: "FEW";
+                readonly MANY: "MANY";
+                readonly OTHER: "OTHER";
+            }>>;
+            formatSpecifier: z.ZodOptional<z.ZodString>;
+            argNum: z.ZodOptional<z.ZodNumber>;
+            isPlural: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TextCode = z.infer<typeof TEXT_CODE_SCHEMA>;
+export type TextUnit = z.infer<typeof TEXT_UNIT_SCHEMA>;
+export type TextUnitTarget = z.infer<typeof TEXT_UNIT_TARGET_SCHEMA>;
+export type TextSegment = z.infer<typeof TEXT_SEGMENT_SCHEMA>;
+//# sourceMappingURL=textUnit.d.ts.map

package/dist/api/textUnit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textUnit.d.ts","sourceRoot":"","sources":["../../src/api/textUnit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAI1B,eAAO,MAAM,mBAAmB,aAI/B,CAAA;AAED,eAAO,MAAM,gBAAgB;;;;CAInB,CAAA;AACV,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAA;AAEnF,eAAO,MAAM,gBAAgB;;;;;;;;;;iBAa1B,CAAA;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;iBAQlC,CAAA;AAEF,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAUlC,CAAA;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuB1B,CAAA;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACvD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACvD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACpE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA"}

package/dist/api/textUnit.js

@@ -0,0 +1,54 @@
+import { z } from 'zod/v4';
+import { LOCALE_BCP47_TAG } from "./common.js";
+import { TEXT_UNIT_METADATA_ATTRIBUTES_SCHEMA } from "./textUnitMetadata.js";
+export const TEXT_SEGMENT_SCHEMA = z.string().describe(`Represents a text segment, a smaller part of a larger text. 
+Segments are created through segmentation, where a text is broken down into smaller units, such as sentences, 
+to facilitate operations like translation and leveraging translation memory.`);
+export const TextCodeTypeEnum = {
+    OPENING: 'OPENING',
+    CLOSING: 'CLOSING',
+    PLACEHOLDER: 'PLACEHOLDER',
+};
+export const TEXT_CODE_SCHEMA = z
+    .object({
+    id: z.string(),
+    type: z.enum(TextCodeTypeEnum),
+    value: z.string(),
+    attributes: z.string().nullish(),
+    parser: z
+        .literal('okapi')
+        .default('okapi')
+        .describe('Indicates the parser that generated this text code.'),
+})
+    .describe('Represents a text code, which is a special marker in the segment text that can be used for various purposes, such as indicating placeholders.');
+export const TEXT_UNIT_SOURCE_SCHEMA = z.object({
+    textCodes: TEXT_CODE_SCHEMA.array().nullish(),
+    hasBeenSegmented: z
+        .boolean()
+        .describe('Indicates whether the segmentation was applied to the text unit.'),
+    segments: TEXT_SEGMENT_SCHEMA.array().describe('The text parts that make up the text unit. If the text unit has not been segmented, the array will contain a single segment.'),
+});
+export const TEXT_UNIT_TARGET_SCHEMA = z.object({
+    hasBeenSegmented: z
+        .boolean()
+        .describe('Indicates whether the segmentation was applied to the text unit.'),
+    segments: TEXT_SEGMENT_SCHEMA.array().describe('The text parts that make up the text unit. If the text unit has not been segmented, the array will contain a single segment.'),
+    metadata: TEXT_UNIT_METADATA_ATTRIBUTES_SCHEMA.optional().describe('Optional metadata associated with the target text unit.'),
+});
+export const TEXT_UNIT_SCHEMA = z
+    .object({
+    id: z.string().min(1).describe('Unique identifier of the text unit within a content unit.'),
+    name: z
+        .string()
+        .optional()
+        .describe('Name of the text unit, if available. For example json key /myNestedObject/myNestedKey'),
+    isTranslatable: z.boolean().describe('Indicates whether the text unit is translatable or not'),
+    source: TEXT_UNIT_SOURCE_SCHEMA,
+    targets: z
+        .record(LOCALE_BCP47_TAG, TEXT_UNIT_TARGET_SCHEMA)
+        .optional()
+        .describe('Map of locale to translation target. Will be present if content is multilingual and translations are available.'),
+    metadata: TEXT_UNIT_METADATA_ATTRIBUTES_SCHEMA.optional().describe('Optional metadata associated with the text unit.'),
+})
+    .describe('Represents a text unit, the basic unit of extraction from a parser. May be split further into segments.');
+//# sourceMappingURL=textUnit.js.map

package/dist/api/textUnit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"textUnit.js","sourceRoot":"","sources":["../../src/api/textUnit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,oCAAoC,EAAE,MAAM,uBAAuB,CAAA;AAE5E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACpD;;6EAE2E,CAC5E,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAA;AAGV,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAChC,MAAM,EAAE,CAAC;SACN,OAAO,CAAC,OAAO,CAAC;SAChB,OAAO,CAAC,OAAO,CAAC;SAChB,QAAQ,CAAC,qDAAqD,CAAC;CACnE,CAAC;KACD,QAAQ,CACP,+IAA+I,CAChJ,CAAA;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,SAAS,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC7C,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,CAAC,kEAAkE,CAAC;IAC/E,QAAQ,EAAE,mBAAmB,CAAC,KAAK,EAAE,CAAC,QAAQ,CAC5C,8HAA8H,CAC/H;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,CAAC,kEAAkE,CAAC;IAC/E,QAAQ,EAAE,mBAAmB,CAAC,KAAK,EAAE,CAAC,QAAQ,CAC5C,8HAA8H,CAC/H;IACD,QAAQ,EAAE,oCAAoC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAChE,yDAAyD,CAC1D;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,2DAA2D,CAAC;IAC3F,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,uFAAuF,CACxF;IACH,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,wDAAwD,CAAC;IAC9F,MAAM,EAAE,uBAAuB;IAC/B,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC;SACjD,QAAQ,EAAE;SACV,QAAQ,CACP,iHAAiH,CAClH;IACH,QAAQ,EAAE,oCAAoC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAChE,kDAAkD,CACnD;CACF,CAAC;KACD,QAAQ,CACP,yGAAyG,CAC1G,CAAA"}