generaltranslation 8.1.4 → 8.1.6

package/dist/index.d.ts

@@ -64,11 +64,11 @@ type JsxChild = string | JsxElement | Variable;
 /**
  * The format of the content
  */
-type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';
+type DataFormat = 'JSX' | 'ICU' | 'I18NEXT' | 'DATE_FNS';
 /**
  * A content type representing JSX, ICU, and I18next messages
  */
-type Content = JsxChildren | IcuMessage | I18nextMessage;
+type Content = JsxChildren | IcuMessage | I18nextMessage | DateFnsMessage;
 /**
  * A content type representing JSX elements
  */
@@ -81,6 +81,10 @@ type IcuMessage = string;
  * A content type representing I18next messages
  */
 type I18nextMessage = string;
+/**
+ * A content type representing DateFns messages
+ */
+type DateFnsMessage = string;
 
 /**
  * ActionType is the type of action to perform on the request.
@@ -111,7 +115,7 @@ type EntryMetadata = {
     scriptCode?: string;
 };
 /**
- * GTRequest is a translation request object for {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage}
+ * GTRequest is a translation request object for {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage} | {@link DateFnsMessage}
  *
  * @param source - The source content to translate.
  * @param targetLocale - The target locale to translate to.
@@ -214,6 +218,46 @@ type EnqueueFilesResult = {
     message: string;
 };
 
+/**
+ * Metadata stored alongside GTJSON file entries.
+ * Keys correspond to the entry id/hash in the GTJSON body.
+ */
+type GTJsonFormatMetadata = Record<string, {
+    context?: string;
+    id?: string;
+    domain?: string;
+    maxChars?: number;
+    dataFormat?: 'JSX' | 'ICU' | 'I18NEXT' | 'DATE_FNS';
+    requestVersion?: number;
+    approved_at?: string | null;
+    approved_by?: string | null;
+    hash?: string;
+    filePaths?: string[];
+}>;
+type FileUpload = {
+    branchId?: string;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
+    content: string;
+    fileName: string;
+    fileFormat: FileFormat;
+    dataFormat?: DataFormat;
+    locale: string;
+    formatMetadata?: GTJsonFormatMetadata;
+    versionId?: string;
+    fileId?: string;
+};
+type UploadFilesOptions = {
+    sourceLocale: string;
+    modelProvider?: string;
+    timeout?: number;
+};
+type UploadFilesResponse = {
+    uploadedFiles: FileReference[];
+    count: number;
+    message: string;
+};
+
 type DownloadFileOptions = {
     timeout?: number;
 };
@@ -232,8 +276,8 @@ type TypedResult = {
     translation: JsxChildren;
     dataFormat: 'JSX';
 } | {
-    translation: I18nextMessage | IcuMessage;
-    dataFormat: 'ICU' | 'I18NEXT';
+    translation: I18nextMessage | IcuMessage | DateFnsMessage;
+    dataFormat: 'ICU' | 'I18NEXT' | 'DATE_FNS';
 };
 /**
  * RequestError is a type that represents an error that occurred during a translation request.
@@ -369,46 +413,6 @@ type CustomRegionMapping = {
     };
 };
 
-/**
- * Metadata stored alongside GTJSON file entries.
- * Keys correspond to the entry id/hash in the GTJSON body.
- */
-type GTJsonFormatMetadata = Record<string, {
-    context?: string;
-    id?: string;
-    domain?: string;
-    maxChars?: number;
-    dataFormat?: 'JSX' | 'ICU';
-    requestVersion?: number;
-    approved_at?: string | null;
-    approved_by?: string | null;
-    hash?: string;
-    filePaths?: string[];
-}>;
-type FileUpload = {
-    branchId?: string;
-    incomingBranchId?: string;
-    checkedOutBranchId?: string;
-    content: string;
-    fileName: string;
-    fileFormat: FileFormat;
-    dataFormat?: DataFormat;
-    locale: string;
-    formatMetadata?: GTJsonFormatMetadata;
-    versionId?: string;
-    fileId?: string;
-};
-type UploadFilesOptions = {
-    sourceLocale: string;
-    modelProvider?: string;
-    timeout?: number;
-};
-type UploadFilesResponse = {
-    uploadedFiles: FileReference[];
-    count: number;
-    message: string;
-};
-
 type ProjectData = {
     id: string;
     name: string;
@@ -706,10 +710,17 @@ declare class GT {
     _translate(source: I18nextMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
         dataFormat?: 'I18NEXT';
     }): Promise<TranslationResult | TranslationError>;
+    /**
+     * Translates the source content to the target locale.
+     * @deprecated Use the {@link translate} method instead.
+     */
+    _translate(source: DateFnsMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
+        dataFormat?: 'DATE_FNS';
+    }): Promise<TranslationResult | TranslationError>;
     /**
      * Translates the source content to the target locale.
      *
-     * @param {Content} source - {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage} The source content to translate.
+     * @param {Content} source - {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage} | {@link DateFnsMessage} 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.
@@ -741,6 +752,9 @@ declare class GT {
     translate(source: I18nextMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
         dataFormat?: 'I18NEXT';
     }): Promise<TranslationResult | TranslationError>;
+    translate(source: DateFnsMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
+        dataFormat?: 'DATE_FNS';
+    }): Promise<TranslationResult | TranslationError>;
     /**
      * Translates multiple source contents to the target locale.
      * Override global metadata by supplying a metadata object for each request.