@generaltranslation/api 0.0.4 → 0.0.5

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 (5) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/index.d.cts +6 -6
  3. package/dist/index.d.mts +6 -6
  4. package/package.json +1 -1
  5. package/spec/openapi.json +12 -12
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @generaltranslation/api
2
2
 
3
+ ## 0.0.5
4
+
5
+ ### Patch Changes
6
+
7
+ - [#2226](https://github.com/generaltranslation/gt/pull/2226) [`44aabc7`](https://github.com/generaltranslation/gt/commit/44aabc734d99fab4fcab7faedc84d20b5772bde3) Thanks [@eoinest](https://github.com/eoinest)! - Rename the `.strings` and `.stringsdict` file formats. The API format names become `DOT_STRINGS` and `DOT_STRINGSDICT`, and the `gt.config.json` keys under `files` become `dotStrings` and `dotStringsdict`.
8
+
9
+ **This is a breaking configuration change.** A `gt.config.json` that still uses `files.strings` or `files.stringsdict` will silently stop matching those files, because the old keys are no longer recognised file types. Rename them to `files.dotStrings` and `files.dotStringsdict`. The file extensions on disk are unchanged, and translated output is still written as `.strings` and `.stringsdict`.
10
+
11
+ The old names identified a vendor rather than a file. Apple ships four string formats — `.strings`, `.stringsdict`, `.xcstrings` and `.plist` — so `APPLE_STRINGS` never said which one it meant. The new names identify the extension itself, the way developers say it out loud.
12
+
3
13
  ## 0.0.4
4
14
 
5
15
  ### Patch Changes
package/dist/index.d.cts CHANGED
@@ -315,7 +315,7 @@ type ClientOptions = {
315
315
  type ErrorResponse = {
316
316
  error: string;
317
317
  };
318
- type FileFormat = 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
318
+ type FileFormat = 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
319
319
  type ModelProvider = 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
320
320
  type JsonObject = {
321
321
  [key: string]: JsonValue;
@@ -455,7 +455,7 @@ type UploadSourceFilesData = {
455
455
  source: {
456
456
  content: string;
457
457
  fileName: string;
458
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
458
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
459
459
  dataFormat?: string;
460
460
  locale: string;
461
461
  fileId?: string;
@@ -544,7 +544,7 @@ type UploadTranslationsData = {
544
544
  source: {
545
545
  content: string;
546
546
  fileName: string;
547
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
547
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
548
548
  dataFormat?: string;
549
549
  locale: string;
550
550
  fileId?: string;
@@ -559,10 +559,10 @@ type UploadTranslationsData = {
559
559
  translations: Array<{
560
560
  content: string;
561
561
  fileName: string;
562
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
562
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
563
563
  dataFormat?: string;
564
564
  locale: string;
565
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
565
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
566
566
  }>;
567
567
  }>;
568
568
  sourceLocale?: string;
@@ -951,7 +951,7 @@ type EnqueueFileTranslationsData = {
951
951
  fileId: string;
952
952
  versionId: string;
953
953
  fileName?: string;
954
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
954
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
955
955
  }>;
956
956
  targetLocales?: Array<string>;
957
957
  sourceLocale?: string;
package/dist/index.d.mts CHANGED
@@ -315,7 +315,7 @@ type ClientOptions = {
315
315
  type ErrorResponse = {
316
316
  error: string;
317
317
  };
318
- type FileFormat = 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
318
+ type FileFormat = 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
319
319
  type ModelProvider = 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
320
320
  type JsonObject = {
321
321
  [key: string]: JsonValue;
@@ -455,7 +455,7 @@ type UploadSourceFilesData = {
455
455
  source: {
456
456
  content: string;
457
457
  fileName: string;
458
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
458
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
459
459
  dataFormat?: string;
460
460
  locale: string;
461
461
  fileId?: string;
@@ -544,7 +544,7 @@ type UploadTranslationsData = {
544
544
  source: {
545
545
  content: string;
546
546
  fileName: string;
547
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
547
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
548
548
  dataFormat?: string;
549
549
  locale: string;
550
550
  fileId?: string;
@@ -559,10 +559,10 @@ type UploadTranslationsData = {
559
559
  translations: Array<{
560
560
  content: string;
561
561
  fileName: string;
562
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
562
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
563
563
  dataFormat?: string;
564
564
  locale: string;
565
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
565
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
566
566
  }>;
567
567
  }>;
568
568
  sourceLocale?: string;
@@ -951,7 +951,7 @@ type EnqueueFileTranslationsData = {
951
951
  fileId: string;
952
952
  versionId: string;
953
953
  fileName?: string;
954
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
954
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'DOT_STRINGS' | 'DOT_STRINGSDICT';
955
955
  }>;
956
956
  targetLocales?: Array<string>;
957
957
  sourceLocale?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@generaltranslation/api",
3
- "version": "0.0.4",
3
+ "version": "0.0.5",
4
4
  "description": "Generated TypeScript SDK for the General Translation API",
5
5
  "type": "module",
6
6
  "sideEffects": false,
package/spec/openapi.json CHANGED
@@ -72,8 +72,8 @@
72
72
  "TWILIO_CONTENT_JSON",
73
73
  "LOTTIE",
74
74
  "SVG",
75
- "APPLE_STRINGS",
76
- "APPLE_STRINGSDICT"
75
+ "DOT_STRINGS",
76
+ "DOT_STRINGSDICT"
77
77
  ]
78
78
  },
79
79
  "ModelProvider": {
@@ -617,8 +617,8 @@
617
617
  "TWILIO_CONTENT_JSON",
618
618
  "LOTTIE",
619
619
  "SVG",
620
- "APPLE_STRINGS",
621
- "APPLE_STRINGSDICT"
620
+ "DOT_STRINGS",
621
+ "DOT_STRINGSDICT"
622
622
  ]
623
623
  },
624
624
  "dataFormat": {
@@ -931,8 +931,8 @@
931
931
  "TWILIO_CONTENT_JSON",
932
932
  "LOTTIE",
933
933
  "SVG",
934
- "APPLE_STRINGS",
935
- "APPLE_STRINGSDICT"
934
+ "DOT_STRINGS",
935
+ "DOT_STRINGSDICT"
936
936
  ]
937
937
  },
938
938
  "dataFormat": {
@@ -1003,8 +1003,8 @@
1003
1003
  "TWILIO_CONTENT_JSON",
1004
1004
  "LOTTIE",
1005
1005
  "SVG",
1006
- "APPLE_STRINGS",
1007
- "APPLE_STRINGSDICT"
1006
+ "DOT_STRINGS",
1007
+ "DOT_STRINGSDICT"
1008
1008
  ]
1009
1009
  },
1010
1010
  "dataFormat": {
@@ -1031,8 +1031,8 @@
1031
1031
  "TWILIO_CONTENT_JSON",
1032
1032
  "LOTTIE",
1033
1033
  "SVG",
1034
- "APPLE_STRINGS",
1035
- "APPLE_STRINGSDICT"
1034
+ "DOT_STRINGS",
1035
+ "DOT_STRINGSDICT"
1036
1036
  ]
1037
1037
  }
1038
1038
  },
@@ -2317,8 +2317,8 @@
2317
2317
  "TWILIO_CONTENT_JSON",
2318
2318
  "LOTTIE",
2319
2319
  "SVG",
2320
- "APPLE_STRINGS",
2321
- "APPLE_STRINGSDICT"
2320
+ "DOT_STRINGS",
2321
+ "DOT_STRINGSDICT"
2322
2322
  ]
2323
2323
  }
2324
2324
  },