generaltranslation 7.0.0 → 7.1.0-alpha.0

package/dist/index.d.ts

@@ -1,5 +1,8 @@
-import { CustomMapping, FormatVariables } from './types';
+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 { LocaleProperties } from './locales/getLocaleProperties';
+import { JsxChildren } from './internal';
+import { FileTranslationQuery } from './types-dir/checkFileTranslations';
+import { CheckTranslationStatusOptions, TranslationStatusResult } from './types-dir/translationStatus';
 /**
  * Type representing the constructor parameters for the GT class.
  * @typedef {Object} GTConstructorParams
@@ -38,7 +41,7 @@ type GTConstructorParams = {
  */
 export declare class GT {
     /** Base URL for the translation service API */
-    baseUrl: string;
+    baseUrl?: string;
     /** Project ID for the translation service */
     projectId?: string;
     /** API key for accessing the translation service */
@@ -70,9 +73,224 @@ export declare class GT {
      *   locales: ['en-US', 'es-ES', 'fr-FR']
      * });
      */
-    constructor({ apiKey, devApiKey, sourceLocale, targetLocale, locales, projectId, customMapping, baseUrl, }?: GTConstructorParams);
-    translatef(): void;
-    mtranslatef(): void;
+    constructor(params?: GTConstructorParams);
+    setConfig({ apiKey, devApiKey, sourceLocale, targetLocale, locales, projectId, customMapping, baseUrl, }: GTConstructorParams): void;
+    private _getTranslationConfig;
+    private _validateAuth;
+    /**
+     * Enqueues translation entries for processing.
+     *
+     * @param {Updates} updates - The translation entries to enqueue.
+     * @param {EnqueueEntriesOptions} options - Options for enqueueing entries.
+     * @param {string} library - The library being used (for context).
+     * @returns {Promise<EnqueueTranslationEntriesResult>} The result of the enqueue operation.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.enqueueEntries([
+     *   {
+     *     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',
+     * });
+     */
+    enqueueEntries(updates: Updates, options?: EnqueueEntriesOptions): Promise<EnqueueEntriesResult>;
+    /**
+     * Enqueues files for translation processing.
+     *
+     * @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.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * 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',
+     * });
+     */
+    enqueueFiles(files: FileToTranslate[], options: EnqueueFilesOptions): Promise<EnqueueFilesResult>;
+    /**
+     * Checks the translation status of files.
+     *
+     * @param {Object} data - Object mapping source paths to file information.
+     * @param {CheckFileTranslationsOptions} options - Options for checking file translations.
+     * @returns {Promise<CheckFileTranslationsResult>} The file translation status information.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.checkFileTranslations([
+     *   { sourcePath: 'src/components/Button.tsx', locale: 'es-ES' },
+     *   { sourcePath: 'src/components/Input.tsx', locale: 'fr-FR' },
+     * ], {
+     *   timeout: 10000,
+     * });
+     *
+     */
+    checkFileTranslations(data: FileTranslationQuery[], options?: CheckFileTranslationsOptions): Promise<CheckFileTranslationsResult>;
+    /**
+     * Checks the translation status of a version.
+     *
+     * @param {string} versionId - The ID of the version to check.
+     * @param {CheckTranslationStatusOptions} options - Options for checking the translation status.
+     * @returns {Promise<TranslationStatusResult>} The translation status of the version.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.checkTranslationStatus('1234567890', {
+     *   timeout: 10000,
+     * });
+     */
+    checkTranslationStatus(versionId: string, options?: CheckTranslationStatusOptions): Promise<TranslationStatusResult>;
+    /**
+     * Downloads a single translation file.
+     *
+     * @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.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.downloadFile('1234567890', {
+     *   timeout: 10000,
+     * });
+     */
+    downloadFile(translationId: string, options?: DownloadFileOptions): Promise<ArrayBuffer>;
+    /**
+     * Downloads multiple translation files in a batch.
+     *
+     * @param {string[]} fileIds - Array of file IDs to download.
+     * @param {DownloadFileBatchOptions} options - Options for the batch download.
+     * @returns {Promise<DownloadFileBatchResult>} The batch download results.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.downloadFileBatch(['1234567890', '1234567891'], {
+     *   timeout: 10000,
+     * });
+     */
+    downloadFileBatch(fileIds: string[], options?: DownloadFileBatchOptions): Promise<DownloadFileBatchResult>;
+    /**
+     * Fetches translation metadata and information.
+     *
+     * @param {string} versionId - The version ID to fetch translations for.
+     * @param {FetchTranslationsOptions} options - Options for fetching translations.
+     * @returns {Promise<FetchTranslationsResult>} The translation metadata and information.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.fetchTranslations('1234567890');
+     */
+    fetchTranslations(versionId: string, options?: FetchTranslationsOptions): Promise<FetchTranslationsResult>;
+    /**
+     * Translates the source content to the target locale.
+     *
+     * @param {Content} source - {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage} The source content to translate.
+     * @param {string} targetLocale - string The target locale to translate to.
+     * @param {EntryMetadata} metadata - {@link EntryMetadata} The metadata for the translation.
+     * @returns {Promise<TranslationResult | TranslationError>} The translated content.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.translate('Hello, world!', 'es-ES');
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.translate('Hello, world!', 'es-ES', { context: 'A formal greeting'});
+     */
+    _translate(source: JsxChildren, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
+        dataFormat?: 'JSX';
+    }): Promise<TranslationResult | TranslationError>;
+    _translate(source: IcuMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
+        dataFormat?: 'ICU';
+    }): Promise<TranslationResult | TranslationError>;
+    _translate(source: I18nextMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
+        dataFormat?: 'I18NEXT';
+    }): Promise<TranslationResult | TranslationError>;
+    /**
+     * Translates multiple source contents to the target locale.
+     * Override global metadata by supplying a metadata object for each request.
+     *
+     * @param {Entry[]} sources - The source contents to translate.
+     * @param {EntryMetadata} globalMetadata - {@link EntryMetadata} The metadata for the translation.
+     * @returns {Promise<TranslateManyResult>} The translated contents.
+     *
+     * @example
+     * const gt = new GT({
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
+     *
+     * const result = await gt.translateMany([
+     *   { source: 'Hello, world!' },
+     *   { source: 'Goodbye, world!' },
+     * ], { targetLocale: 'es-ES' });
+     */
+    translateMany(sources: Entry[], globalMetadata?: {
+        targetLocale: string;
+    } & EntryMetadata): Promise<TranslateManyResult>;
     /**
      * Formats a message according to the specified locales and options.
      *