@generaltranslation/api 0.0.2 → 0.0.4

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 +16 -0
  2. package/dist/index.d.cts +20 -15
  3. package/dist/index.d.mts +20 -15
  4. package/package.json +1 -1
  5. package/spec/openapi.json +78 -16
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @generaltranslation/api
2
2
 
3
+ ## 0.0.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [#2222](https://github.com/generaltranslation/gt/pull/2222) [`091c964`](https://github.com/generaltranslation/gt/commit/091c964b45eba191d6e35bc1cdb93cc3683a3f71) Thanks [@eoinest](https://github.com/eoinest)! - Add Apple `.strings` support to the CLI. Configure a `strings` entry under `files` in `gt.config.json` to upload `.strings` sources and download the translated per-locale files. `.strings` files written as UTF-16 by older versions of Xcode upload correctly: their bytes are sent unmodified so the API can read the byte order mark.
8
+
9
+ Fix `save-local` for formats whose content travels base64. It compared the local file against the still-encoded server copy, so a Lottie translation reported an edit on every run. Unchanged files are now recognised, and an edited file whose bytes are not valid UTF-8 is reported by name rather than submitted as unreadable text.
10
+
11
+ - [#2222](https://github.com/generaltranslation/gt/pull/2222) [`b8a9679`](https://github.com/generaltranslation/gt/commit/b8a96797860f2bb7b12f3c307d47c9b1fead2096) Thanks [@eoinest](https://github.com/eoinest)! - Add Apple `.stringsdict` support to the CLI. Configure a `stringsdict` entry under `files` in `gt.config.json` to upload `.stringsdict` plural rule sources and download the translated per-locale files.
12
+
13
+ ## 0.0.3
14
+
15
+ ### Patch Changes
16
+
17
+ - [#2208](https://github.com/generaltranslation/gt/pull/2208) [`0ce6acc`](https://github.com/generaltranslation/gt/commit/0ce6acc7ab27fb392c48b1dbd7cc24bd4c4b7755) Thanks [@internal-gt-public-api-sync](https://github.com/apps/internal-gt-public-api-sync)! - Sync the GT API OpenAPI contract and regenerate the SDK.
18
+
3
19
  ## 0.0.2
4
20
 
5
21
  ### Patch Changes
package/dist/index.d.cts CHANGED
@@ -315,7 +315,14 @@ 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';
318
+ type FileFormat = 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
319
+ type ModelProvider = 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
320
+ type JsonObject = {
321
+ [key: string]: JsonValue;
322
+ };
323
+ type JsonValue = string | number | boolean | null | Array<JsonValue | null> | {
324
+ [key: string]: JsonValue | null;
325
+ };
319
326
  type Branch = {
320
327
  id: string;
321
328
  name: string;
@@ -323,7 +330,7 @@ type Branch = {
323
330
  type RuntimeTranslationResponse = {
324
331
  [key: string]: {
325
332
  success: true;
326
- translation?: unknown;
333
+ translation?: JsonValue;
327
334
  dataFormat: 'JSX' | 'ICU' | 'I18NEXT' | 'STRING';
328
335
  locale: string;
329
336
  } | {
@@ -342,7 +349,7 @@ type RuntimeTranslationRequest = {
342
349
  context?: string;
343
350
  maxChars?: number;
344
351
  dataFormat?: 'JSX' | 'ICU' | 'I18NEXT' | 'STRING';
345
- actionType?: 'fast';
352
+ actionType?: 'fast' | 'standard';
346
353
  sourceCode?: {
347
354
  [key: string]: Array<{
348
355
  before: string;
@@ -356,7 +363,7 @@ type RuntimeTranslationRequest = {
356
363
  targetLocale: string;
357
364
  sourceLocale: string;
358
365
  metadata: {
359
- modelProvider?: 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
366
+ modelProvider?: ModelProvider;
360
367
  };
361
368
  };
362
369
  type CreateCliWizardSessionResponse = {
@@ -448,7 +455,7 @@ type UploadSourceFilesData = {
448
455
  source: {
449
456
  content: string;
450
457
  fileName: string;
451
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
458
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
452
459
  dataFormat?: string;
453
460
  locale: string;
454
461
  fileId?: string;
@@ -537,7 +544,7 @@ type UploadTranslationsData = {
537
544
  source: {
538
545
  content: string;
539
546
  fileName: string;
540
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
547
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
541
548
  dataFormat?: string;
542
549
  locale: string;
543
550
  fileId?: string;
@@ -552,10 +559,10 @@ type UploadTranslationsData = {
552
559
  translations: Array<{
553
560
  content: string;
554
561
  fileName: string;
555
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
562
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
556
563
  dataFormat?: string;
557
564
  locale: string;
558
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
565
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
559
566
  }>;
560
567
  }>;
561
568
  sourceLocale?: string;
@@ -944,12 +951,12 @@ type EnqueueFileTranslationsData = {
944
951
  fileId: string;
945
952
  versionId: string;
946
953
  fileName?: string;
947
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
954
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
948
955
  }>;
949
956
  targetLocales?: Array<string>;
950
957
  sourceLocale?: string;
951
958
  force?: boolean;
952
- modelProvider?: 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
959
+ modelProvider?: ModelProvider;
953
960
  publish?: boolean;
954
961
  };
955
962
  headers?: {
@@ -1024,7 +1031,7 @@ type EnqueueFileTranslationsResponses = {
1024
1031
  projectId: string;
1025
1032
  force: boolean;
1026
1033
  outputFileFormat?: FileFormat;
1027
- modelProvider?: 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
1034
+ modelProvider?: ModelProvider;
1028
1035
  glossaryRetranslate?: boolean;
1029
1036
  changedGlossaryTerms?: Array<string>;
1030
1037
  onComplete?: {
@@ -1255,9 +1262,7 @@ type DownloadFilesResponses = {
1255
1262
  locale?: string;
1256
1263
  fileName?: string;
1257
1264
  data: string;
1258
- metadata: {
1259
- [key: string]: unknown;
1260
- };
1265
+ metadata: JsonObject;
1261
1266
  fileFormat: FileFormat;
1262
1267
  }>;
1263
1268
  count: number;
@@ -2366,5 +2371,5 @@ declare const deleteCliWizardSession: <ThrowOnError extends boolean = false>(opt
2366
2371
  */
2367
2372
  declare const getCliWizardSession: <ThrowOnError extends boolean = false>(options: Options<GetCliWizardSessionData, ThrowOnError>) => RequestResult<GetCliWizardSessionResponses, GetCliWizardSessionErrors, ThrowOnError, "fields">;
2368
2373
  //#endregion
2369
- export { API_VERSION, type ApiClientConfig, type ApiVersion, type AwaitJobsOptions, type AwaitJobsResult, type BatchOptions, Branch, CliWizardSessionReadyResponse, CliWizardSessionWaitingResponse, type Client, ClientOptions, CreateBranchData, CreateBranchError, CreateBranchErrors, CreateBranchResponse, CreateBranchResponses, CreateCliWizardSessionData, CreateCliWizardSessionError, CreateCliWizardSessionErrors, CreateCliWizardSessionRequest, CreateCliWizardSessionResponse, CreateCliWizardSessionResponse2, CreateCliWizardSessionResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, DEFAULT_BATCH_SIZE, DeleteCliWizardSessionData, DeleteCliWizardSessionError, DeleteCliWizardSessionErrors, DeleteCliWizardSessionResponse, DeleteCliWizardSessionResponse2, DeleteCliWizardSessionResponses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, DownloadFilesData, DownloadFilesError, DownloadFilesErrors, DownloadFilesResponse, DownloadFilesResponses, EnqueueFileTranslationsData, EnqueueFileTranslationsError, EnqueueFileTranslationsErrors, EnqueueFileTranslationsResponse, EnqueueFileTranslationsResponses, ErrorResponse, FileFormat, GenerateProjectContextData, GenerateProjectContextError, GenerateProjectContextErrors, GenerateProjectContextResponse, GenerateProjectContextResponses, GetBranchInfoData, GetBranchInfoError, GetBranchInfoErrors, GetBranchInfoResponse, GetBranchInfoResponses, GetCliWizardSessionData, GetCliWizardSessionError, GetCliWizardSessionErrors, GetCliWizardSessionResponse, GetCliWizardSessionResponses, GetFileInfoData, GetFileInfoError, GetFileInfoErrors, GetFileInfoResponse, GetFileInfoResponses, GetOrphanedFilesData, GetOrphanedFilesError, GetOrphanedFilesErrors, GetOrphanedFilesResponse, GetOrphanedFilesResponses, GetProjectContextGenerationStatusData, GetProjectContextGenerationStatusError, GetProjectContextGenerationStatusErrors, GetProjectContextGenerationStatusResponse, GetProjectContextGenerationStatusResponses, GetProjectInfoData, GetProjectInfoError, GetProjectInfoErrors, GetProjectInfoResponse, GetProjectInfoResponses, GetTranslationJobInfoData, GetTranslationJobInfoError, GetTranslationJobInfoErrors, GetTranslationJobInfoResponse, GetTranslationJobInfoResponses, GetTranslationStatusData, GetTranslationStatusError, GetTranslationStatusErrors, GetTranslationStatusResponse, GetTranslationStatusResponses, type JobResult, Options, ProcessFileMovesData, ProcessFileMovesError, ProcessFileMovesErrors, ProcessFileMovesResponse, ProcessFileMovesResponses, PublishFilesData, PublishFilesError, PublishFilesErrors, PublishFilesResponse, PublishFilesResponses, type RetryPolicy, RuntimeTranslationRequest, RuntimeTranslationResponse, ShouldGenerateProjectContextData, ShouldGenerateProjectContextError, ShouldGenerateProjectContextErrors, ShouldGenerateProjectContextResponse, ShouldGenerateProjectContextResponses, SubmitUserEditDiffsData, SubmitUserEditDiffsError, SubmitUserEditDiffsErrors, SubmitUserEditDiffsResponse, SubmitUserEditDiffsResponses, TranslateData, TranslateError, TranslateErrors, TranslateResponse, TranslateResponses, UpdateProjectInfoData, UpdateProjectInfoError, UpdateProjectInfoErrors, UpdateProjectInfoResponse, UpdateProjectInfoResponses, UploadAssetsData, UploadAssetsError, UploadAssetsErrors, UploadAssetsResponse, UploadAssetsResponses, UploadSourceFilesData, UploadSourceFilesError, UploadSourceFilesErrors, UploadSourceFilesResponse, UploadSourceFilesResponses, UploadTranslationsData, UploadTranslationsError, UploadTranslationsErrors, UploadTranslationsResponse, UploadTranslationsResponses, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectContextGenerationStatus, getProjectInfo, getTranslationJobInfo, getTranslationStatus, processBatches, processFileMoves, publishFiles, shouldGenerateProjectContext, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
2374
+ export { API_VERSION, type ApiClientConfig, type ApiVersion, type AwaitJobsOptions, type AwaitJobsResult, type BatchOptions, Branch, CliWizardSessionReadyResponse, CliWizardSessionWaitingResponse, type Client, ClientOptions, CreateBranchData, CreateBranchError, CreateBranchErrors, CreateBranchResponse, CreateBranchResponses, CreateCliWizardSessionData, CreateCliWizardSessionError, CreateCliWizardSessionErrors, CreateCliWizardSessionRequest, CreateCliWizardSessionResponse, CreateCliWizardSessionResponse2, CreateCliWizardSessionResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, DEFAULT_BATCH_SIZE, DeleteCliWizardSessionData, DeleteCliWizardSessionError, DeleteCliWizardSessionErrors, DeleteCliWizardSessionResponse, DeleteCliWizardSessionResponse2, DeleteCliWizardSessionResponses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, DownloadFilesData, DownloadFilesError, DownloadFilesErrors, DownloadFilesResponse, DownloadFilesResponses, EnqueueFileTranslationsData, EnqueueFileTranslationsError, EnqueueFileTranslationsErrors, EnqueueFileTranslationsResponse, EnqueueFileTranslationsResponses, ErrorResponse, FileFormat, GenerateProjectContextData, GenerateProjectContextError, GenerateProjectContextErrors, GenerateProjectContextResponse, GenerateProjectContextResponses, GetBranchInfoData, GetBranchInfoError, GetBranchInfoErrors, GetBranchInfoResponse, GetBranchInfoResponses, GetCliWizardSessionData, GetCliWizardSessionError, GetCliWizardSessionErrors, GetCliWizardSessionResponse, GetCliWizardSessionResponses, GetFileInfoData, GetFileInfoError, GetFileInfoErrors, GetFileInfoResponse, GetFileInfoResponses, GetOrphanedFilesData, GetOrphanedFilesError, GetOrphanedFilesErrors, GetOrphanedFilesResponse, GetOrphanedFilesResponses, GetProjectContextGenerationStatusData, GetProjectContextGenerationStatusError, GetProjectContextGenerationStatusErrors, GetProjectContextGenerationStatusResponse, GetProjectContextGenerationStatusResponses, GetProjectInfoData, GetProjectInfoError, GetProjectInfoErrors, GetProjectInfoResponse, GetProjectInfoResponses, GetTranslationJobInfoData, GetTranslationJobInfoError, GetTranslationJobInfoErrors, GetTranslationJobInfoResponse, GetTranslationJobInfoResponses, GetTranslationStatusData, GetTranslationStatusError, GetTranslationStatusErrors, GetTranslationStatusResponse, GetTranslationStatusResponses, type JobResult, JsonObject, JsonValue, ModelProvider, Options, ProcessFileMovesData, ProcessFileMovesError, ProcessFileMovesErrors, ProcessFileMovesResponse, ProcessFileMovesResponses, PublishFilesData, PublishFilesError, PublishFilesErrors, PublishFilesResponse, PublishFilesResponses, type RetryPolicy, RuntimeTranslationRequest, RuntimeTranslationResponse, ShouldGenerateProjectContextData, ShouldGenerateProjectContextError, ShouldGenerateProjectContextErrors, ShouldGenerateProjectContextResponse, ShouldGenerateProjectContextResponses, SubmitUserEditDiffsData, SubmitUserEditDiffsError, SubmitUserEditDiffsErrors, SubmitUserEditDiffsResponse, SubmitUserEditDiffsResponses, TranslateData, TranslateError, TranslateErrors, TranslateResponse, TranslateResponses, UpdateProjectInfoData, UpdateProjectInfoError, UpdateProjectInfoErrors, UpdateProjectInfoResponse, UpdateProjectInfoResponses, UploadAssetsData, UploadAssetsError, UploadAssetsErrors, UploadAssetsResponse, UploadAssetsResponses, UploadSourceFilesData, UploadSourceFilesError, UploadSourceFilesErrors, UploadSourceFilesResponse, UploadSourceFilesResponses, UploadTranslationsData, UploadTranslationsError, UploadTranslationsErrors, UploadTranslationsResponse, UploadTranslationsResponses, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectContextGenerationStatus, getProjectInfo, getTranslationJobInfo, getTranslationStatus, processBatches, processFileMoves, publishFiles, shouldGenerateProjectContext, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
2370
2375
  //# sourceMappingURL=index.d.cts.map
package/dist/index.d.mts CHANGED
@@ -315,7 +315,14 @@ 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';
318
+ type FileFormat = 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
319
+ type ModelProvider = 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
320
+ type JsonObject = {
321
+ [key: string]: JsonValue;
322
+ };
323
+ type JsonValue = string | number | boolean | null | Array<JsonValue | null> | {
324
+ [key: string]: JsonValue | null;
325
+ };
319
326
  type Branch = {
320
327
  id: string;
321
328
  name: string;
@@ -323,7 +330,7 @@ type Branch = {
323
330
  type RuntimeTranslationResponse = {
324
331
  [key: string]: {
325
332
  success: true;
326
- translation?: unknown;
333
+ translation?: JsonValue;
327
334
  dataFormat: 'JSX' | 'ICU' | 'I18NEXT' | 'STRING';
328
335
  locale: string;
329
336
  } | {
@@ -342,7 +349,7 @@ type RuntimeTranslationRequest = {
342
349
  context?: string;
343
350
  maxChars?: number;
344
351
  dataFormat?: 'JSX' | 'ICU' | 'I18NEXT' | 'STRING';
345
- actionType?: 'fast';
352
+ actionType?: 'fast' | 'standard';
346
353
  sourceCode?: {
347
354
  [key: string]: Array<{
348
355
  before: string;
@@ -356,7 +363,7 @@ type RuntimeTranslationRequest = {
356
363
  targetLocale: string;
357
364
  sourceLocale: string;
358
365
  metadata: {
359
- modelProvider?: 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
366
+ modelProvider?: ModelProvider;
360
367
  };
361
368
  };
362
369
  type CreateCliWizardSessionResponse = {
@@ -448,7 +455,7 @@ type UploadSourceFilesData = {
448
455
  source: {
449
456
  content: string;
450
457
  fileName: string;
451
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
458
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
452
459
  dataFormat?: string;
453
460
  locale: string;
454
461
  fileId?: string;
@@ -537,7 +544,7 @@ type UploadTranslationsData = {
537
544
  source: {
538
545
  content: string;
539
546
  fileName: string;
540
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
547
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
541
548
  dataFormat?: string;
542
549
  locale: string;
543
550
  fileId?: string;
@@ -552,10 +559,10 @@ type UploadTranslationsData = {
552
559
  translations: Array<{
553
560
  content: string;
554
561
  fileName: string;
555
- fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
562
+ fileFormat: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
556
563
  dataFormat?: string;
557
564
  locale: string;
558
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
565
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
559
566
  }>;
560
567
  }>;
561
568
  sourceLocale?: string;
@@ -944,12 +951,12 @@ type EnqueueFileTranslationsData = {
944
951
  fileId: string;
945
952
  versionId: string;
946
953
  fileName?: string;
947
- transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG';
954
+ transformFormat?: 'GTJSON' | 'MDX' | 'JSON' | 'YAML' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'PO' | 'POT' | 'TWILIO_CONTENT_JSON' | 'LOTTIE' | 'SVG' | 'APPLE_STRINGS' | 'APPLE_STRINGSDICT';
948
955
  }>;
949
956
  targetLocales?: Array<string>;
950
957
  sourceLocale?: string;
951
958
  force?: boolean;
952
- modelProvider?: 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
959
+ modelProvider?: ModelProvider;
953
960
  publish?: boolean;
954
961
  };
955
962
  headers?: {
@@ -1024,7 +1031,7 @@ type EnqueueFileTranslationsResponses = {
1024
1031
  projectId: string;
1025
1032
  force: boolean;
1026
1033
  outputFileFormat?: FileFormat;
1027
- modelProvider?: 'ANTHROPIC' | 'OPENAI' | 'XAI' | 'GOOGLE';
1034
+ modelProvider?: ModelProvider;
1028
1035
  glossaryRetranslate?: boolean;
1029
1036
  changedGlossaryTerms?: Array<string>;
1030
1037
  onComplete?: {
@@ -1255,9 +1262,7 @@ type DownloadFilesResponses = {
1255
1262
  locale?: string;
1256
1263
  fileName?: string;
1257
1264
  data: string;
1258
- metadata: {
1259
- [key: string]: unknown;
1260
- };
1265
+ metadata: JsonObject;
1261
1266
  fileFormat: FileFormat;
1262
1267
  }>;
1263
1268
  count: number;
@@ -2366,5 +2371,5 @@ declare const deleteCliWizardSession: <ThrowOnError extends boolean = false>(opt
2366
2371
  */
2367
2372
  declare const getCliWizardSession: <ThrowOnError extends boolean = false>(options: Options<GetCliWizardSessionData, ThrowOnError>) => RequestResult<GetCliWizardSessionResponses, GetCliWizardSessionErrors, ThrowOnError, "fields">;
2368
2373
  //#endregion
2369
- export { API_VERSION, type ApiClientConfig, type ApiVersion, type AwaitJobsOptions, type AwaitJobsResult, type BatchOptions, Branch, CliWizardSessionReadyResponse, CliWizardSessionWaitingResponse, type Client, ClientOptions, CreateBranchData, CreateBranchError, CreateBranchErrors, CreateBranchResponse, CreateBranchResponses, CreateCliWizardSessionData, CreateCliWizardSessionError, CreateCliWizardSessionErrors, CreateCliWizardSessionRequest, CreateCliWizardSessionResponse, CreateCliWizardSessionResponse2, CreateCliWizardSessionResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, DEFAULT_BATCH_SIZE, DeleteCliWizardSessionData, DeleteCliWizardSessionError, DeleteCliWizardSessionErrors, DeleteCliWizardSessionResponse, DeleteCliWizardSessionResponse2, DeleteCliWizardSessionResponses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, DownloadFilesData, DownloadFilesError, DownloadFilesErrors, DownloadFilesResponse, DownloadFilesResponses, EnqueueFileTranslationsData, EnqueueFileTranslationsError, EnqueueFileTranslationsErrors, EnqueueFileTranslationsResponse, EnqueueFileTranslationsResponses, ErrorResponse, FileFormat, GenerateProjectContextData, GenerateProjectContextError, GenerateProjectContextErrors, GenerateProjectContextResponse, GenerateProjectContextResponses, GetBranchInfoData, GetBranchInfoError, GetBranchInfoErrors, GetBranchInfoResponse, GetBranchInfoResponses, GetCliWizardSessionData, GetCliWizardSessionError, GetCliWizardSessionErrors, GetCliWizardSessionResponse, GetCliWizardSessionResponses, GetFileInfoData, GetFileInfoError, GetFileInfoErrors, GetFileInfoResponse, GetFileInfoResponses, GetOrphanedFilesData, GetOrphanedFilesError, GetOrphanedFilesErrors, GetOrphanedFilesResponse, GetOrphanedFilesResponses, GetProjectContextGenerationStatusData, GetProjectContextGenerationStatusError, GetProjectContextGenerationStatusErrors, GetProjectContextGenerationStatusResponse, GetProjectContextGenerationStatusResponses, GetProjectInfoData, GetProjectInfoError, GetProjectInfoErrors, GetProjectInfoResponse, GetProjectInfoResponses, GetTranslationJobInfoData, GetTranslationJobInfoError, GetTranslationJobInfoErrors, GetTranslationJobInfoResponse, GetTranslationJobInfoResponses, GetTranslationStatusData, GetTranslationStatusError, GetTranslationStatusErrors, GetTranslationStatusResponse, GetTranslationStatusResponses, type JobResult, Options, ProcessFileMovesData, ProcessFileMovesError, ProcessFileMovesErrors, ProcessFileMovesResponse, ProcessFileMovesResponses, PublishFilesData, PublishFilesError, PublishFilesErrors, PublishFilesResponse, PublishFilesResponses, type RetryPolicy, RuntimeTranslationRequest, RuntimeTranslationResponse, ShouldGenerateProjectContextData, ShouldGenerateProjectContextError, ShouldGenerateProjectContextErrors, ShouldGenerateProjectContextResponse, ShouldGenerateProjectContextResponses, SubmitUserEditDiffsData, SubmitUserEditDiffsError, SubmitUserEditDiffsErrors, SubmitUserEditDiffsResponse, SubmitUserEditDiffsResponses, TranslateData, TranslateError, TranslateErrors, TranslateResponse, TranslateResponses, UpdateProjectInfoData, UpdateProjectInfoError, UpdateProjectInfoErrors, UpdateProjectInfoResponse, UpdateProjectInfoResponses, UploadAssetsData, UploadAssetsError, UploadAssetsErrors, UploadAssetsResponse, UploadAssetsResponses, UploadSourceFilesData, UploadSourceFilesError, UploadSourceFilesErrors, UploadSourceFilesResponse, UploadSourceFilesResponses, UploadTranslationsData, UploadTranslationsError, UploadTranslationsErrors, UploadTranslationsResponse, UploadTranslationsResponses, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectContextGenerationStatus, getProjectInfo, getTranslationJobInfo, getTranslationStatus, processBatches, processFileMoves, publishFiles, shouldGenerateProjectContext, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
2374
+ export { API_VERSION, type ApiClientConfig, type ApiVersion, type AwaitJobsOptions, type AwaitJobsResult, type BatchOptions, Branch, CliWizardSessionReadyResponse, CliWizardSessionWaitingResponse, type Client, ClientOptions, CreateBranchData, CreateBranchError, CreateBranchErrors, CreateBranchResponse, CreateBranchResponses, CreateCliWizardSessionData, CreateCliWizardSessionError, CreateCliWizardSessionErrors, CreateCliWizardSessionRequest, CreateCliWizardSessionResponse, CreateCliWizardSessionResponse2, CreateCliWizardSessionResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, DEFAULT_BATCH_SIZE, DeleteCliWizardSessionData, DeleteCliWizardSessionError, DeleteCliWizardSessionErrors, DeleteCliWizardSessionResponse, DeleteCliWizardSessionResponse2, DeleteCliWizardSessionResponses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, DownloadFilesData, DownloadFilesError, DownloadFilesErrors, DownloadFilesResponse, DownloadFilesResponses, EnqueueFileTranslationsData, EnqueueFileTranslationsError, EnqueueFileTranslationsErrors, EnqueueFileTranslationsResponse, EnqueueFileTranslationsResponses, ErrorResponse, FileFormat, GenerateProjectContextData, GenerateProjectContextError, GenerateProjectContextErrors, GenerateProjectContextResponse, GenerateProjectContextResponses, GetBranchInfoData, GetBranchInfoError, GetBranchInfoErrors, GetBranchInfoResponse, GetBranchInfoResponses, GetCliWizardSessionData, GetCliWizardSessionError, GetCliWizardSessionErrors, GetCliWizardSessionResponse, GetCliWizardSessionResponses, GetFileInfoData, GetFileInfoError, GetFileInfoErrors, GetFileInfoResponse, GetFileInfoResponses, GetOrphanedFilesData, GetOrphanedFilesError, GetOrphanedFilesErrors, GetOrphanedFilesResponse, GetOrphanedFilesResponses, GetProjectContextGenerationStatusData, GetProjectContextGenerationStatusError, GetProjectContextGenerationStatusErrors, GetProjectContextGenerationStatusResponse, GetProjectContextGenerationStatusResponses, GetProjectInfoData, GetProjectInfoError, GetProjectInfoErrors, GetProjectInfoResponse, GetProjectInfoResponses, GetTranslationJobInfoData, GetTranslationJobInfoError, GetTranslationJobInfoErrors, GetTranslationJobInfoResponse, GetTranslationJobInfoResponses, GetTranslationStatusData, GetTranslationStatusError, GetTranslationStatusErrors, GetTranslationStatusResponse, GetTranslationStatusResponses, type JobResult, JsonObject, JsonValue, ModelProvider, Options, ProcessFileMovesData, ProcessFileMovesError, ProcessFileMovesErrors, ProcessFileMovesResponse, ProcessFileMovesResponses, PublishFilesData, PublishFilesError, PublishFilesErrors, PublishFilesResponse, PublishFilesResponses, type RetryPolicy, RuntimeTranslationRequest, RuntimeTranslationResponse, ShouldGenerateProjectContextData, ShouldGenerateProjectContextError, ShouldGenerateProjectContextErrors, ShouldGenerateProjectContextResponse, ShouldGenerateProjectContextResponses, SubmitUserEditDiffsData, SubmitUserEditDiffsError, SubmitUserEditDiffsErrors, SubmitUserEditDiffsResponse, SubmitUserEditDiffsResponses, TranslateData, TranslateError, TranslateErrors, TranslateResponse, TranslateResponses, UpdateProjectInfoData, UpdateProjectInfoError, UpdateProjectInfoErrors, UpdateProjectInfoResponse, UpdateProjectInfoResponses, UploadAssetsData, UploadAssetsError, UploadAssetsErrors, UploadAssetsResponse, UploadAssetsResponses, UploadSourceFilesData, UploadSourceFilesError, UploadSourceFilesErrors, UploadSourceFilesResponse, UploadSourceFilesResponses, UploadTranslationsData, UploadTranslationsError, UploadTranslationsErrors, UploadTranslationsResponse, UploadTranslationsResponses, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectContextGenerationStatus, getProjectInfo, getTranslationJobInfo, getTranslationStatus, processBatches, processFileMoves, publishFiles, shouldGenerateProjectContext, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
2370
2375
  //# sourceMappingURL=index.d.mts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@generaltranslation/api",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "Generated TypeScript SDK for the General Translation API",
5
5
  "type": "module",
6
6
  "sideEffects": false,
package/spec/openapi.json CHANGED
@@ -71,7 +71,61 @@
71
71
  "POT",
72
72
  "TWILIO_CONTENT_JSON",
73
73
  "LOTTIE",
74
- "SVG"
74
+ "SVG",
75
+ "APPLE_STRINGS",
76
+ "APPLE_STRINGSDICT"
77
+ ]
78
+ },
79
+ "ModelProvider": {
80
+ "type": "string",
81
+ "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
82
+ },
83
+ "JsonObject": {
84
+ "type": "object",
85
+ "additionalProperties": {
86
+ "$ref": "#/components/schemas/JsonValue"
87
+ }
88
+ },
89
+ "JsonValue": {
90
+ "anyOf": [
91
+ {
92
+ "type": "string"
93
+ },
94
+ {
95
+ "type": "number"
96
+ },
97
+ {
98
+ "type": "boolean"
99
+ },
100
+ {
101
+ "type": "null"
102
+ },
103
+ {
104
+ "type": "array",
105
+ "items": {
106
+ "oneOf": [
107
+ {
108
+ "$ref": "#/components/schemas/JsonValue"
109
+ },
110
+ {
111
+ "type": "null"
112
+ }
113
+ ]
114
+ }
115
+ },
116
+ {
117
+ "type": "object",
118
+ "additionalProperties": {
119
+ "oneOf": [
120
+ {
121
+ "$ref": "#/components/schemas/JsonValue"
122
+ },
123
+ {
124
+ "type": "null"
125
+ }
126
+ ]
127
+ }
128
+ }
75
129
  ]
76
130
  },
77
131
  "Branch": {
@@ -97,7 +151,9 @@
97
151
  "type": "boolean",
98
152
  "enum": [true]
99
153
  },
100
- "translation": {},
154
+ "translation": {
155
+ "$ref": "#/components/schemas/JsonValue"
156
+ },
101
157
  "dataFormat": {
102
158
  "type": "string",
103
159
  "enum": ["JSX", "ICU", "I18NEXT", "STRING"]
@@ -158,7 +214,7 @@
158
214
  },
159
215
  "actionType": {
160
216
  "type": "string",
161
- "enum": ["fast"],
217
+ "enum": ["fast", "standard"],
162
218
  "default": "fast"
163
219
  },
164
220
  "sourceCode": {
@@ -203,8 +259,7 @@
203
259
  "type": "object",
204
260
  "properties": {
205
261
  "modelProvider": {
206
- "type": "string",
207
- "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
262
+ "$ref": "#/components/schemas/ModelProvider"
208
263
  }
209
264
  }
210
265
  }
@@ -561,7 +616,9 @@
561
616
  "POT",
562
617
  "TWILIO_CONTENT_JSON",
563
618
  "LOTTIE",
564
- "SVG"
619
+ "SVG",
620
+ "APPLE_STRINGS",
621
+ "APPLE_STRINGSDICT"
565
622
  ]
566
623
  },
567
624
  "dataFormat": {
@@ -873,7 +930,9 @@
873
930
  "POT",
874
931
  "TWILIO_CONTENT_JSON",
875
932
  "LOTTIE",
876
- "SVG"
933
+ "SVG",
934
+ "APPLE_STRINGS",
935
+ "APPLE_STRINGSDICT"
877
936
  ]
878
937
  },
879
938
  "dataFormat": {
@@ -943,7 +1002,9 @@
943
1002
  "POT",
944
1003
  "TWILIO_CONTENT_JSON",
945
1004
  "LOTTIE",
946
- "SVG"
1005
+ "SVG",
1006
+ "APPLE_STRINGS",
1007
+ "APPLE_STRINGSDICT"
947
1008
  ]
948
1009
  },
949
1010
  "dataFormat": {
@@ -969,7 +1030,9 @@
969
1030
  "POT",
970
1031
  "TWILIO_CONTENT_JSON",
971
1032
  "LOTTIE",
972
- "SVG"
1033
+ "SVG",
1034
+ "APPLE_STRINGS",
1035
+ "APPLE_STRINGSDICT"
973
1036
  ]
974
1037
  }
975
1038
  },
@@ -2253,7 +2316,9 @@
2253
2316
  "POT",
2254
2317
  "TWILIO_CONTENT_JSON",
2255
2318
  "LOTTIE",
2256
- "SVG"
2319
+ "SVG",
2320
+ "APPLE_STRINGS",
2321
+ "APPLE_STRINGSDICT"
2257
2322
  ]
2258
2323
  }
2259
2324
  },
@@ -2276,8 +2341,7 @@
2276
2341
  "default": false
2277
2342
  },
2278
2343
  "modelProvider": {
2279
- "type": "string",
2280
- "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
2344
+ "$ref": "#/components/schemas/ModelProvider"
2281
2345
  },
2282
2346
  "publish": {
2283
2347
  "type": "boolean"
@@ -2332,8 +2396,7 @@
2332
2396
  "$ref": "#/components/schemas/FileFormat"
2333
2397
  },
2334
2398
  "modelProvider": {
2335
- "type": "string",
2336
- "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
2399
+ "$ref": "#/components/schemas/ModelProvider"
2337
2400
  },
2338
2401
  "glossaryRetranslate": {
2339
2402
  "type": "boolean"
@@ -3158,8 +3221,7 @@
3158
3221
  "type": "string"
3159
3222
  },
3160
3223
  "metadata": {
3161
- "type": "object",
3162
- "additionalProperties": {}
3224
+ "$ref": "#/components/schemas/JsonObject"
3163
3225
  },
3164
3226
  "fileFormat": {
3165
3227
  "$ref": "#/components/schemas/FileFormat"