generaltranslation 7.6.0 → 7.6.2

package/dist/index.d.ts

@@ -5,10 +5,11 @@ import { SetupProjectResult } from './translate/setupProject';
 import { CheckSetupStatusResult } from './translate/checkSetupStatus';
 import { ShouldSetupProjectResult } from './translate/shouldSetupProject';
 import { EnqueueOptions } from './translate/enqueueFiles';
-import { FileTranslationQuery } from './types-dir/checkFileTranslations';
+import { FileQuery, FileQueryResult, FileTranslationQuery } from './types-dir/checkFileTranslations';
 import { CheckTranslationStatusOptions, TranslationStatusResult } from './types-dir/translationStatus';
 import { CustomRegionMapping } from './locales/getRegionProperties';
-import { FileUpload, FileUploadRef, UploadFilesOptions } from './types-dir/uploadFiles';
+import { FileUpload, FileUploadRef, UploadFilesOptions, UploadFilesResponse } from './types-dir/uploadFiles';
+import { ProjectData } from './types-dir/project';
 /**
  * Type representing the constructor parameters for the GT class.
  * @typedef {Object} GTConstructorParams
@@ -189,6 +190,48 @@ export declare class GT {
      *
      */
     checkFileTranslations(data: FileTranslationQuery[], options?: CheckFileTranslationsOptions): Promise<CheckFileTranslationsResult>;
+    /**
+     * Gets source and translation information for a given file ID and version ID.
+     *
+     * @param {FileQuery} data - File query containing file ID and version ID.
+     * @param {CheckFileTranslationsOptions} options - Options for getting source and translation information.
+     * @returns {Promise<FileQueryResult>} The source file and translation information.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.querySourceFile(
+     *   { fileId: '1234567890', versionId: '1234567890' },
+     *   { timeout: 10000 }
+     * );
+     *
+     */
+    querySourceFile(data: FileQuery, options?: CheckFileTranslationsOptions): Promise<FileQueryResult>;
+    /**
+     * Get project data for a given project ID.
+     *
+     * @param {string} projectId - The ID of the project to get the data for.
+     * @returns {Promise<ProjectData>} The project data.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.getProjectData(
+     *   '1234567890'
+     * );
+     *
+     */
+    getProjectData(projectId: string, options?: {
+        timeout?: number;
+    }): Promise<ProjectData>;
     /**
      * Checks the translation status of a version.
      *
@@ -215,7 +258,7 @@ export declare class GT {
      * @param {string} translationId - The ID of the translation to download.
      * @param {DownloadFileOptions} options - Options for downloading the file.
      * @returns {Promise<DownloadFileResult>} The downloaded file content and metadata.
-     *
+     * @deprecated Use the {@link downloadTranslatedFile} method instead. Will be removed in v7.0.0.
      * @example
      * const gt = new GT({
      *   sourceLocale: 'en-US',
@@ -228,6 +271,33 @@ export declare class GT {
      * });
      */
     downloadFile(translationId: string, options?: DownloadFileOptions): Promise<ArrayBuffer>;
+    /**
+     * Downloads a single translated file.
+     *
+     * @param {string} file - The file to download.
+     * @param {DownloadFileOptions} options - Options for downloading the file.
+     * @returns {Promise<string>} The downloaded file content.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.downloadTranslatedFile({
+     *   fileId: '1234567890',
+     *   locale: 'es-ES',
+     *   versionId: '1234567890',
+     * }, {
+     *   timeout: 10000,
+     * });
+     */
+    downloadTranslatedFile(file: {
+        fileId: string;
+        locale: string;
+        versionId?: string;
+    }, options?: DownloadFileOptions): Promise<string>;
     /**
      * Downloads multiple translation files in a batch.
      *
@@ -353,11 +423,11 @@ export declare class GT {
      *
      * @param {Array<{source: FileUpload}>} files - Array of objects containing source file data to upload
      * @param {UploadFilesOptions} options - Configuration options including source locale and other upload settings
-     * @returns {Promise<any>} Upload result containing file IDs, version information, and upload status
+     * @returns {Promise<UploadFilesResponse>} Upload result containing file IDs, version information, and upload status
      */
     uploadSourceFiles(files: {
         source: FileUpload;
-    }[], options: UploadFilesOptions): Promise<any>;
+    }[], options: UploadFilesOptions): Promise<UploadFilesResponse>;
     /**
      * Uploads translation files that correspond to previously uploaded source files.
      *
@@ -370,12 +440,12 @@ export declare class GT {
      *   - `source`: Reference to the existing source file (contains IDs but no content)
      *   - `translations`: Array of translated files, each containing content, locale, and reference IDs
      * @param {UploadFilesOptions} options - Configuration options including source locale and upload settings
-     * @returns {Promise<any>} Upload result containing translation IDs, status, and processing information
+     * @returns {Promise<UploadFilesResponse>} Upload result containing translation IDs, status, and processing information
      */
     uploadTranslations(files: {
         source: FileUpload;
         translations: FileUpload[];
-    }[], options: UploadFilesOptions): Promise<any>;
+    }[], options: UploadFilesOptions): Promise<UploadFilesResponse>;
     /**
      * Formats a message according to the specified locales and options.
      *