generaltranslation 8.1.19 → 8.1.21

package/dist/translate/awaitJobs.d.ts

@@ -0,0 +1,19 @@
+import { JobStatus } from './checkJobStatus';
+export type AwaitJobsOptions = {
+    /** Polling interval in seconds. Defaults to 5. */
+    pollingIntervalSeconds?: number;
+    /** Timeout in seconds. Defaults to 600 (10 minutes). If reached, resolves with whatever status is current. */
+    timeoutSeconds?: number;
+};
+export type JobResult = {
+    jobId: string;
+    status: JobStatus;
+    error?: {
+        message: string;
+    };
+};
+export type AwaitJobsResult = {
+    /** Whether all jobs completed (none still in progress). */
+    complete: boolean;
+    jobs: JobResult[];
+};

package/dist/translate/enqueueFiles.d.ts

@@ -1,5 +1,5 @@
 export type EnqueueOptions = {
-    sourceLocale: string;
+    sourceLocale?: string;
     targetLocales: string[];
     requireApproval?: boolean;
     modelProvider?: string;

package/dist/translate/publishFiles.d.ts

@@ -9,6 +9,8 @@ export type PublishFilesResult = {
     results: {
         fileId: string;
         versionId: string;
+        locale?: string;
+        branchId: string;
         success: boolean;
         error?: string;
     }[];

package/dist/types-dir/api/downloadFileBatch.d.ts

@@ -4,6 +4,7 @@ export type DownloadFileBatchRequest = {
     branchId?: string;
     versionId?: string;
     locale?: string;
+    useLatestAvailableVersion?: boolean;
 }[];
 export type DownloadFileBatchOptions = {
     timeout?: number;

package/dist/types-dir/api/file.d.ts

@@ -14,10 +14,11 @@ type FormatMetadata = Record<string, any> | Updates[number]['metadata'];
  * @property {string} [incomingBranchId] - The ID of the incoming branch of the file
  * @property {string} [checkedOutBranchId] - The ID of the checked out branch of the file
  */
-export type FileToUpload = FileReferenceOptionalBranchId & {
+export type FileToUpload = Omit<FileReference, 'branchId'> & {
     content: string;
     locale: string;
     formatMetadata?: FormatMetadata;
+    branchId?: string;
     incomingBranchId?: string;
     checkedOutBranchId?: string;
 };
@@ -44,7 +45,10 @@ export type FileReference = {
  * @see {@link FileReference}
  * @property {string} [branchId] - The ID of the branch of the file
  */
-export type FileReferenceOptionalBranchId = Omit<FileReference, 'branchId'> & {
+export type FileReferenceIds = Omit<FileReference, 'branchId' | 'fileName' | 'fileFormat' | 'dataFormat'> & {
     branchId?: string;
+    fileName?: string;
+    fileFormat?: FileFormat;
+    dataFormat?: DataFormat;
 };
 export {};

package/dist/types.d.ts

@@ -208,10 +208,11 @@ type FormatMetadata = Record<string, any> | Updates[number]['metadata'];
  * @property {string} [incomingBranchId] - The ID of the incoming branch of the file
  * @property {string} [checkedOutBranchId] - The ID of the checked out branch of the file
  */
-type FileToUpload = FileReferenceOptionalBranchId & {
+type FileToUpload = Omit<FileReference, 'branchId'> & {
     content: string;
     locale: string;
     formatMetadata?: FormatMetadata;
+    branchId?: string;
     incomingBranchId?: string;
     checkedOutBranchId?: string;
 };
@@ -233,14 +234,6 @@ type FileReference = {
     fileFormat: FileFormat;
     dataFormat?: DataFormat;
 };
-/**
- * File reference object structure for referencing files
- * @see {@link FileReference}
- * @property {string} [branchId] - The ID of the branch of the file
- */
-type FileReferenceOptionalBranchId = Omit<FileReference, 'branchId'> & {
-    branchId?: string;
-};
 
 type DownloadFileBatchOptions = {
     timeout?: number;
@@ -335,6 +328,8 @@ type PublishFilesResult = {
     results: {
         fileId: string;
         versionId: string;
+        locale?: string;
+        branchId: string;
         success: boolean;
         error?: string;
     }[];
@@ -485,6 +480,25 @@ type CheckJobStatusResult = {
     };
 }[];
 
+type AwaitJobsOptions = {
+    /** Polling interval in seconds. Defaults to 5. */
+    pollingIntervalSeconds?: number;
+    /** Timeout in seconds. Defaults to 600 (10 minutes). If reached, resolves with whatever status is current. */
+    timeoutSeconds?: number;
+};
+type JobResult = {
+    jobId: string;
+    status: JobStatus;
+    error?: {
+        message: string;
+    };
+};
+type AwaitJobsResult = {
+    /** Whether all jobs completed (none still in progress). */
+    complete: boolean;
+    jobs: JobResult[];
+};
+
 type SubmitUserEditDiff = {
     fileName: string;
     locale: string;
@@ -602,4 +616,4 @@ type TranslationRequestConfig = {
 };
 
 export { HTML_CONTENT_PROPS };
-export type { BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, GetOrphanedFilesResult, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, MoveMapping, MoveResult, OrphanedFile, ProcessMovesOptions, ProcessMovesResponse, PublishFileEntry, PublishFilesResult, Request, RetrievedTranslations, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyEntry, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };
+export type { AwaitJobsOptions, AwaitJobsResult, BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, GetOrphanedFilesResult, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, JobResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, MoveMapping, MoveResult, OrphanedFile, ProcessMovesOptions, ProcessMovesResponse, PublishFileEntry, PublishFilesResult, Request, RetrievedTranslations, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyEntry, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "8.1.19",
+  "version": "8.1.21",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.cjs.min.cjs",
   "module": "dist/index.esm.min.mjs",