@lokalise/content-conversion-schemas 5.9.0 → 6.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 (42) hide show
  1. package/dist/api/contentObjects.d.ts +240 -102
  2. package/dist/api/contentObjects.d.ts.map +1 -1
  3. package/dist/api/contentObjects.js +2 -2
  4. package/dist/api/contentObjects.js.map +1 -1
  5. package/dist/api/contentObjectsNew.d.ts +601 -256
  6. package/dist/api/contentObjectsNew.d.ts.map +1 -1
  7. package/dist/api/contentObjectsNew.js +2 -2
  8. package/dist/api/contentObjectsNew.js.map +1 -1
  9. package/dist/api/generationObjects.d.ts +720 -306
  10. package/dist/api/generationObjects.d.ts.map +1 -1
  11. package/dist/api/pluralForm.d.ts +10 -0
  12. package/dist/api/pluralForm.d.ts.map +1 -0
  13. package/dist/api/pluralForm.js +9 -0
  14. package/dist/api/pluralForm.js.map +1 -0
  15. package/dist/api/textSegment.d.ts +4 -0
  16. package/dist/api/textSegment.d.ts.map +1 -0
  17. package/dist/api/textSegment.js +5 -0
  18. package/dist/api/textSegment.js.map +1 -0
  19. package/dist/api/textUnit.d.ts +336 -56
  20. package/dist/api/textUnit.d.ts.map +1 -1
  21. package/dist/api/textUnit.js +35 -24
  22. package/dist/api/textUnit.js.map +1 -1
  23. package/dist/api/textUnitMetadata.js +1 -1
  24. package/dist/api/textUnitMetadata.js.map +1 -1
  25. package/dist/api/textUnitTarget.d.ts +69 -0
  26. package/dist/api/textUnitTarget.d.ts.map +1 -0
  27. package/dist/api/textUnitTarget.js +30 -0
  28. package/dist/api/textUnitTarget.js.map +1 -0
  29. package/dist/api/translationObjects.d.ts +5 -5
  30. package/dist/api/{xcstings.d.ts → xcstrings.d.ts} +4 -10
  31. package/dist/api/xcstrings.d.ts.map +1 -0
  32. package/dist/api/{xcstings.js → xcstrings.js} +5 -9
  33. package/dist/api/xcstrings.js.map +1 -0
  34. package/dist/events/conversion.d.ts +1852 -817
  35. package/dist/events/conversion.d.ts.map +1 -1
  36. package/dist/index.d.ts +3 -1
  37. package/dist/index.d.ts.map +1 -1
  38. package/dist/index.js +3 -1
  39. package/dist/index.js.map +1 -1
  40. package/package.json +3 -3
  41. package/dist/api/xcstings.d.ts.map +0 -1
  42. package/dist/api/xcstings.js.map +0 -1
@@ -0,0 +1,69 @@
1
+ import { z } from 'zod/v4';
2
+ export declare const TARGET_METADATA: z.ZodObject<{
3
+ xcstrings: z.ZodOptional<z.ZodObject<{
4
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
5
+ }, z.core.$strip>>;
6
+ }, z.core.$strip>;
7
+ export declare const SOURCE_WITH_METADATA: z.ZodObject<{
8
+ hasBeenSegmented: z.ZodBoolean;
9
+ segments: z.ZodArray<z.ZodString>;
10
+ metadata: z.ZodOptional<z.ZodObject<{
11
+ xcstrings: z.ZodOptional<z.ZodObject<{
12
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
13
+ }, z.core.$strip>>;
14
+ }, z.core.$strip>>;
15
+ }, z.core.$strip>;
16
+ export declare const TARGET_BASE: z.ZodObject<{
17
+ isPlural: z.ZodBoolean;
18
+ }, z.core.$strip>;
19
+ export declare const TARGET_SOURCE: z.ZodObject<{
20
+ isPlural: z.ZodLiteral<false>;
21
+ source: z.ZodObject<{
22
+ hasBeenSegmented: z.ZodBoolean;
23
+ segments: z.ZodArray<z.ZodString>;
24
+ metadata: z.ZodOptional<z.ZodObject<{
25
+ xcstrings: z.ZodOptional<z.ZodObject<{
26
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
27
+ }, z.core.$strip>>;
28
+ }, z.core.$strip>>;
29
+ }, z.core.$strip>;
30
+ }, z.core.$strip>;
31
+ export declare const PLURAL_TARGET_SOURCE: z.ZodObject<{
32
+ isPlural: z.ZodLiteral<true>;
33
+ pluralForms: z.ZodRecord<z.ZodString, z.ZodObject<{
34
+ hasBeenSegmented: z.ZodBoolean;
35
+ segments: z.ZodArray<z.ZodString>;
36
+ metadata: z.ZodOptional<z.ZodObject<{
37
+ xcstrings: z.ZodOptional<z.ZodObject<{
38
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
39
+ }, z.core.$strip>>;
40
+ }, z.core.$strip>>;
41
+ }, z.core.$strip>>;
42
+ }, z.core.$strip>;
43
+ export declare const TEXT_UNIT_TARGET: z.ZodDiscriminatedUnion<[z.ZodObject<{
44
+ isPlural: z.ZodLiteral<false>;
45
+ source: z.ZodObject<{
46
+ hasBeenSegmented: z.ZodBoolean;
47
+ segments: z.ZodArray<z.ZodString>;
48
+ metadata: z.ZodOptional<z.ZodObject<{
49
+ xcstrings: z.ZodOptional<z.ZodObject<{
50
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
51
+ }, z.core.$strip>>;
52
+ }, z.core.$strip>>;
53
+ }, z.core.$strip>;
54
+ }, z.core.$strip>, z.ZodObject<{
55
+ isPlural: z.ZodLiteral<true>;
56
+ pluralForms: z.ZodRecord<z.ZodString, z.ZodObject<{
57
+ hasBeenSegmented: z.ZodBoolean;
58
+ segments: z.ZodArray<z.ZodString>;
59
+ metadata: z.ZodOptional<z.ZodObject<{
60
+ xcstrings: z.ZodOptional<z.ZodObject<{
61
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
62
+ }, z.core.$strip>>;
63
+ }, z.core.$strip>>;
64
+ }, z.core.$strip>>;
65
+ }, z.core.$strip>]>;
66
+ export type TargetMetadata = z.infer<typeof TARGET_METADATA>;
67
+ export type SourceWithMetadata = z.infer<typeof SOURCE_WITH_METADATA>;
68
+ export type TextUnitTarget = z.infer<typeof TEXT_UNIT_TARGET>;
69
+ //# sourceMappingURL=textUnitTarget.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"textUnitTarget.d.ts","sourceRoot":"","sources":["../../src/api/textUnitTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAK1B,eAAO,MAAM,eAAe;;;;iBAE1B,CAAA;AAEF,eAAO,MAAM,oBAAoB;;;;;;;;iBAM/B,CAAA;AAEF,eAAO,MAAM,WAAW;;iBAEtB,CAAA;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;iBAGxB,CAAA;AAEF,eAAO,MAAM,oBAAoB;;;;;;;;;;;iBAS/B,CAAA;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;mBAG3B,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAC5D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACrE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
@@ -0,0 +1,30 @@
1
+ import { z } from 'zod/v4';
2
+ import { PluralFormEnum } from "./pluralForm.js";
3
+ import { TEXT_SEGMENT } from "./textSegment.js";
4
+ import { XCSTRINGS_TARGET_METADATA } from "./xcstrings.js";
5
+ export const TARGET_METADATA = z.object({
6
+ xcstrings: XCSTRINGS_TARGET_METADATA.optional(),
7
+ });
8
+ export const SOURCE_WITH_METADATA = z.object({
9
+ hasBeenSegmented: z.boolean(),
10
+ segments: TEXT_SEGMENT.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.'),
11
+ metadata: TARGET_METADATA.optional(),
12
+ });
13
+ export const TARGET_BASE = z.object({
14
+ isPlural: z.boolean(),
15
+ });
16
+ export const TARGET_SOURCE = TARGET_BASE.extend({
17
+ isPlural: z.literal(false),
18
+ source: SOURCE_WITH_METADATA,
19
+ });
20
+ export const PLURAL_TARGET_SOURCE = TARGET_BASE.extend({
21
+ isPlural: z.literal(true),
22
+ pluralForms: z
23
+ .record(z.string().min(1), SOURCE_WITH_METADATA)
24
+ .refine((obj) => Object.keys(obj).every((k) => Object.values(PluralFormEnum).includes(k)), { message: 'All keys must be valid PluralFormEnum values' }),
25
+ });
26
+ export const TEXT_UNIT_TARGET = z.discriminatedUnion('isPlural', [
27
+ TARGET_SOURCE,
28
+ PLURAL_TARGET_SOURCE,
29
+ ]);
30
+ //# sourceMappingURL=textUnitTarget.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"textUnitTarget.js","sourceRoot":"","sources":["../../src/api/textUnitTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAmB,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAA;AAE1D,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,SAAS,EAAE,yBAAyB,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC7B,QAAQ,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,CACrC,8HAA8H,CAC/H;IACD,QAAQ,EAAE,eAAe,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;CACtB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,WAAW,CAAC,MAAM,CAAC;IAC9C,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC1B,MAAM,EAAE,oBAAoB;CAC7B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC,MAAM,CAAC;IACrD,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACzB,WAAW,EAAE,CAAC;SACX,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC;SAC/C,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CACN,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAAe,CAAC,CAAC,EACxF,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAC5D;CACJ,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,kBAAkB,CAAC,UAAU,EAAE;IAC/D,aAAa;IACb,oBAAoB;CACrB,CAAC,CAAA"}
@@ -165,8 +165,8 @@ export declare const TRANSLATED_CONTENT_UNIT_BASE: z.ZodObject<{
165
165
  readonly JSON: "JSON";
166
166
  readonly CONTENTFUL_RICH_TEXT: "CONTENTFUL_RICH_TEXT";
167
167
  }>;
168
- id: z.ZodString;
169
168
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
169
+ id: z.ZodString;
170
170
  }, z.core.$strip>;
171
171
  export declare const TRANSLATED_CONTENT_UNIT: z.ZodObject<{
172
172
  type: z.ZodEnum<{
@@ -184,8 +184,8 @@ export declare const TRANSLATED_CONTENT_UNIT: z.ZodObject<{
184
184
  readonly JSON: "JSON";
185
185
  readonly CONTENTFUL_RICH_TEXT: "CONTENTFUL_RICH_TEXT";
186
186
  }>;
187
- id: z.ZodString;
188
187
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
188
+ id: z.ZodString;
189
189
  translatedSource: z.ZodUnion<readonly [z.ZodObject<{
190
190
  type: z.ZodLiteral<"inline">;
191
191
  value: z.ZodString;
@@ -215,8 +215,8 @@ export declare const FAILED_TRANSLATABLE_CONTENT_UNIT_SCHEMA: z.ZodObject<{
215
215
  readonly JSON: "JSON";
216
216
  readonly CONTENTFUL_RICH_TEXT: "CONTENTFUL_RICH_TEXT";
217
217
  }>;
218
- id: z.ZodString;
219
218
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
219
+ id: z.ZodString;
220
220
  }, z.core.$strip>;
221
221
  error: z.ZodString;
222
222
  }, z.core.$strip>;
@@ -242,8 +242,8 @@ export declare const ITEM_TRANSLATION_RESULT_SCHEMA: z.ZodObject<{
242
242
  readonly JSON: "JSON";
243
243
  readonly CONTENTFUL_RICH_TEXT: "CONTENTFUL_RICH_TEXT";
244
244
  }>;
245
- id: z.ZodString;
246
245
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
246
+ id: z.ZodString;
247
247
  translatedSource: z.ZodUnion<readonly [z.ZodObject<{
248
248
  type: z.ZodLiteral<"inline">;
249
249
  value: z.ZodString;
@@ -272,8 +272,8 @@ export declare const ITEM_TRANSLATION_RESULT_SCHEMA: z.ZodObject<{
272
272
  readonly JSON: "JSON";
273
273
  readonly CONTENTFUL_RICH_TEXT: "CONTENTFUL_RICH_TEXT";
274
274
  }>;
275
- id: z.ZodString;
276
275
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
276
+ id: z.ZodString;
277
277
  }, z.core.$strip>;
278
278
  error: z.ZodString;
279
279
  }, z.core.$strip>>;
@@ -7,15 +7,6 @@ export declare const AppleDeviceTypeEnum: {
7
7
  readonly OTHER: "OTHER";
8
8
  };
9
9
  export type AppleDeviceType = (typeof AppleDeviceTypeEnum)[keyof typeof AppleDeviceTypeEnum];
10
- export declare const PluralFormEnum: {
11
- readonly ZERO: "ZERO";
12
- readonly ONE: "ONE";
13
- readonly TWO: "TWO";
14
- readonly FEW: "FEW";
15
- readonly MANY: "MANY";
16
- readonly OTHER: "OTHER";
17
- };
18
- export type PluralForm = (typeof PluralFormEnum)[keyof typeof PluralFormEnum];
19
10
  export declare const XcStringsLocalisationTypeEnum: {
20
11
  readonly STRING_UNIT: "STRING_UNIT";
21
12
  readonly SUBSTITUTIONS: "SUBSTITUTIONS";
@@ -55,4 +46,7 @@ export declare const XCSTRINGS_TEXT_UNIT_METADATA: z.ZodObject<{
55
46
  argNum: z.ZodOptional<z.ZodNumber>;
56
47
  isPlural: z.ZodBoolean;
57
48
  }, z.core.$strip>;
58
- //# sourceMappingURL=xcstings.d.ts.map
49
+ export declare const XCSTRINGS_TARGET_METADATA: z.ZodObject<{
50
+ state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
51
+ }, z.core.$strip>;
52
+ //# sourceMappingURL=xcstrings.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"xcstrings.d.ts","sourceRoot":"","sources":["../../src/api/xcstrings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAG1B,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAA;AACV,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAA;AAE5F,eAAO,MAAM,6BAA6B;;;;;;CAMhC,CAAA;AACV,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAA;AAEpF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsCvC,CAAA;AAEF,eAAO,MAAM,yBAAyB;;iBAEpC,CAAA"}
@@ -1,4 +1,5 @@
1
1
  import { z } from 'zod/v4';
2
+ import { PluralFormEnum } from "./pluralForm.js";
2
3
  export const AppleDeviceTypeEnum = {
3
4
  MAC: 'MAC',
4
5
  IPHONE: 'IPHONE',
@@ -6,14 +7,6 @@ export const AppleDeviceTypeEnum = {
6
7
  IPAD: 'IPAD',
7
8
  OTHER: 'OTHER',
8
9
  };
9
- export const PluralFormEnum = {
10
- ZERO: 'ZERO',
11
- ONE: 'ONE',
12
- TWO: 'TWO',
13
- FEW: 'FEW',
14
- MANY: 'MANY',
15
- OTHER: 'OTHER',
16
- };
17
10
  export const XcStringsLocalisationTypeEnum = {
18
11
  STRING_UNIT: 'STRING_UNIT',
19
12
  SUBSTITUTIONS: 'SUBSTITUTIONS',
@@ -52,4 +45,7 @@ export const XCSTRINGS_TEXT_UNIT_METADATA = z.object({
52
45
  .describe('which argument index is used for this substitution'),
53
46
  isPlural: z.boolean().describe('Indicates whether the text unit is plural or not'),
54
47
  });
55
- //# sourceMappingURL=xcstings.js.map
48
+ export const XCSTRINGS_TARGET_METADATA = z.object({
49
+ state: z.string().nullish(),
50
+ });
51
+ //# sourceMappingURL=xcstrings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"xcstrings.js","sourceRoot":"","sources":["../../src/api/xcstrings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAA;AAGV,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,eAAe;IAC9B,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,uBAAuB,EAAE,yBAAyB;CAC1C,CAAA;AAIV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yDAAyD,CAAC;IAChG,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;IAC/F,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yMAAyM,CAC1M;IACH,gBAAgB,EAAE,CAAC;SAChB,IAAI,CAAC,6BAA6B,CAAC;SACnC,QAAQ,CACP,0FAA0F,CAC3F;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,oJAAoJ,CACrJ;IACH,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACrF,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,cAAc,CAAC;SACpB,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,kHAAkH,CACnH;IACH,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,kDAAkD,CAAC;CACnF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;CAC5B,CAAC,CAAA"}