generaltranslation 7.5.0 → 7.6.1

package/dist/index.d.ts

@@ -1,10 +1,14 @@
-import { CustomMapping, FormatVariables, I18nextMessage, IcuMessage, TranslateManyResult, TranslationError, TranslationResult, Updates, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, FileToTranslate, CheckFileTranslationsOptions, CheckFileTranslationsResult, DownloadFileBatchOptions, DownloadFileBatchResult, FetchTranslationsOptions, FetchTranslationsResult, DownloadFileOptions, EntryMetadata, Entry } from './types';
+import { CustomMapping, FormatVariables, I18nextMessage, IcuMessage, TranslateManyResult, TranslationError, TranslationResult, Updates, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesResult, CheckFileTranslationsOptions, CheckFileTranslationsResult, DownloadFileBatchOptions, DownloadFileBatchResult, FetchTranslationsOptions, FetchTranslationsResult, DownloadFileOptions, EntryMetadata, Entry } from './types';
 import { LocaleProperties } from './locales/getLocaleProperties';
 import { JsxChildren } from './internal';
+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 { CheckTranslationStatusOptions, TranslationStatusResult } from './types-dir/translationStatus';
 import { CustomRegionMapping } from './locales/getRegionProperties';
-import { FileUpload, UploadFilesOptions } from './types-dir/uploadFiles';
+import { FileUpload, FileUploadRef, UploadFilesOptions, UploadFilesResponse } from './types-dir/uploadFiles';
 /**
  * Type representing the constructor parameters for the GT class.
  * @typedef {Object} GTConstructorParams
@@ -115,34 +119,53 @@ export declare class GT {
      */
     enqueueEntries(updates: Updates, options?: EnqueueEntriesOptions): Promise<EnqueueEntriesResult>;
     /**
-     * Enqueues files for translation processing.
+     * Enqueues project setup job using the specified file references
      *
-     * @param {FileToTranslate[]} files - Array of files to enqueue for translation.
-     * @param {EnqueueFilesOptions} options - Options for enqueueing files.
-     * @returns {Promise<EnqueueFilesResult>} The result of the enqueue operation.
+     * This method creates setup jobs that will process source file references
+     * and generate a project setup. The files parameter contains references (IDs) to source
+     * files that have already been uploaded via uploadSourceFiles. The setup jobs are queued
+     * for processing and will generate a project setup based on the source files.
      *
-     * @example
-     * const gt = new GT({
-     *   sourceLocale: 'en-US',
-     *   targetLocale: 'es-ES',
-     *   locales: ['en-US', 'es-ES', 'fr-FR']
-     * });
+     * @param {FileUploadRef[]} files - Array of file references containing IDs of previously uploaded source files
+     * @param {number} [timeoutMs] - Optional timeout in milliseconds for the API request
+     * @returns {Promise<SetupProjectResult>} Object containing the jobId and status
+     */
+    setupProject(files: FileUploadRef[], timeoutMs?: number): Promise<SetupProjectResult>;
+    /**
+     * Checks the current status of a project setup job by its unique identifier.
      *
-     * const result = await gt.enqueueFiles([
-     *   {
-     *     content: 'Hello, world!',
-     *     fileName: 'Button.tsx',
-     *     fileFormat: 'TS',
-     *     dataFormat: 'JSX',
-     *   },
-     * ], {
-     *   sourceLocale: 'en-US',
-     *   targetLocales: ['es-ES', 'fr-FR'],
-     *   publish: true,
-     *   description: 'Translations for the Button component',
-     * });
+     * This method polls the API to determine whether a setup job is still running,
+     * has completed successfully, or has failed. Setup jobs are created when
+     * uploading source files to initialize project translation workflows.
+     *
+     * @param {string} jobId - The unique identifier of the setup job to check
+     * @param {number} [timeoutMs] - Optional timeout in milliseconds for the API request
+     * @returns {Promise<CheckSetupStatusResult>} Object containing the job status
+     */
+    checkSetupStatus(jobId: string, timeoutMs?: number): Promise<CheckSetupStatusResult>;
+    /**
+     * Checks if a prpject requires setup.
+     *
+     * This method queries API to check if a project has been set up and returns
+     * true if setup is missing
+     *
+     * @returns {Promise<ShouldSetupProjectResult>} Object containing shouldSetupProject
+     */
+    shouldSetupProject(): Promise<ShouldSetupProjectResult>;
+    /**
+     * Enqueues translation jobs for previously uploaded source files.
+     *
+     * This method creates translation jobs that will process existing source files
+     * and generate translations in the specified target languages. The files parameter
+     * contains references (IDs) to source files that have already been uploaded via
+     * uploadSourceFiles. The translation jobs are queued for processing and will
+     * generate translated content based on the source files and target locales provided.
+     *
+     * @param {FileUploadRef[]} 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: FileToTranslate[], options: EnqueueFilesOptions): Promise<EnqueueFilesResult>;
+    enqueueFiles(files: FileUploadRef[], options: EnqueueOptions): Promise<EnqueueFilesResult>;
     /**
      * Checks the translation status of files.
      *
@@ -174,6 +197,7 @@ export declare class GT {
      * @returns {Promise<TranslationStatusResult>} The translation status of the version.
      *
      * @example
+     * @deprecated Use the {@link checkFileTranslations} method instead. Will be removed in v7.0.0.
      * const gt = new GT({
      *   sourceLocale: 'en-US',
      *   targetLocale: 'es-ES',
@@ -319,10 +343,39 @@ export declare class GT {
     translateMany(sources: Entry[], globalMetadata?: {
         targetLocale: string;
     } & EntryMetadata): Promise<TranslateManyResult>;
-    uploadFiles(files: {
+    /**
+     * Uploads source files to the translation service without any translation content.
+     *
+     * This method creates or replaces source file entries in your project. Each uploaded
+     * file becomes a source that can later be translated into target languages. The files
+     * are processed and stored as base entries that serve as the foundation for generating
+     * translations through the translation workflow.
+     *
+     * @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<UploadFilesResponse>} Upload result containing file IDs, version information, and upload status
+     */
+    uploadSourceFiles(files: {
+        source: FileUpload;
+    }[], options: UploadFilesOptions): Promise<UploadFilesResponse>;
+    /**
+     * Uploads translation files that correspond to previously uploaded source files.
+     *
+     * This method allows you to provide translated content for existing source files in your project.
+     * Each translation must reference an existing source file and include the translated content
+     * along with the target locale information. This is used when you have pre-existing translations
+     * that you want to upload directly rather than generating them through the translation service.
+     *
+     * @param {Array<{source: FileUpload, translations: FileUpload[]}>} files - Array of file objects where:
+     *   - `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<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.
      *