generaltranslation 8.1.19 → 8.1.21

package/dist/index.d.ts

@@ -195,8 +195,11 @@ type FileReference = {
  * @see {@link FileReference}
  * @property {string} [branchId] - The ID of the branch of the file
  */
-type FileReferenceOptionalBranchId = Omit<FileReference, 'branchId'> & {
+type FileReferenceIds = Omit<FileReference, 'branchId' | 'fileName' | 'fileFormat' | 'dataFormat'> & {
     branchId?: string;
+    fileName?: string;
+    fileFormat?: FileFormat;
+    dataFormat?: DataFormat;
 };
 
 type DownloadFileBatchRequest = {
@@ -204,6 +207,7 @@ type DownloadFileBatchRequest = {
     branchId?: string;
     versionId?: string;
     locale?: string;
+    useLatestAvailableVersion?: boolean;
 }[];
 type DownloadFileBatchOptions = {
     timeout?: number;
@@ -276,6 +280,8 @@ type PublishFilesResult = {
     results: {
         fileId: string;
         versionId: string;
+        locale?: string;
+        branchId: string;
         success: boolean;
         error?: string;
     }[];
@@ -419,6 +425,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;
@@ -447,7 +472,7 @@ type SetupProjectOptions = {
 };
 
 type EnqueueOptions = {
-    sourceLocale: string;
+    sourceLocale?: string;
     targetLocales: string[];
     requireApproval?: boolean;
     modelProvider?: string;
@@ -653,6 +678,14 @@ declare class GT {
      * });
      */
     checkJobStatus(jobIds: string[], timeoutMs?: number): Promise<CheckJobStatusResult>;
+    /**
+     * Polls job statuses until all jobs from enqueueFiles are finished or the timeout is reached.
+     *
+     * @param {EnqueueFilesResult} enqueueResult - The result returned from enqueueFiles
+     * @param {AwaitJobsOptions} [options] - Polling configuration (interval, timeout)
+     * @returns {Promise<AwaitJobsResult>} The final status of all jobs and whether they all completed
+     */
+    awaitJobs(enqueueResult: EnqueueFilesResult, options?: AwaitJobsOptions): Promise<AwaitJobsResult>;
     /**
      * Enqueues translation jobs for previously uploaded source files.
      *
@@ -662,11 +695,11 @@ declare class GT {
      * uploadSourceFiles. The translation jobs are queued for processing and will
      * generate translated content based on the source files and target locales provided.
      *
-     * @param {FileReference[]} files - Array of file references containing IDs of previously uploaded source files
+     * @param {FileReferenceIds[]} files - Array of file references containing IDs of previously uploaded source files
      * @param {EnqueueOptions} options - Configuration options including source locale, target locales, and job settings
      * @returns {Promise<EnqueueFilesResult>} Result containing job IDs, queue status, and processing information
      */
-    enqueueFiles(files: FileReferenceOptionalBranchId[], options: EnqueueOptions): Promise<EnqueueFilesResult>;
+    enqueueFiles(files: FileReferenceIds[], options: EnqueueOptions): Promise<EnqueueFilesResult>;
     /**
      * Publishes or unpublishes files on the CDN.
      *
@@ -758,6 +791,7 @@ declare class GT {
         branchId?: string;
         locale?: string;
         versionId?: string;
+        useLatestAvailableVersion?: boolean;
     }, options?: DownloadFileOptions): Promise<string>;
     /**
      * Downloads multiple files in a batch.