generaltranslation 7.9.1 → 8.0.0

package/dist/translate/api.d.ts

@@ -0,0 +1 @@
+export declare const API_VERSION = "2025-11-03.v1";

package/dist/translate/checkJobStatus.d.ts

@@ -0,0 +1,8 @@
+export type JobStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'unknown';
+export type CheckJobStatusResult = {
+    jobId: string;
+    status: JobStatus;
+    error?: {
+        message: string;
+    };
+}[];

package/dist/translate/createBranch.d.ts

@@ -0,0 +1,10 @@
+export type CreateBranchQuery = {
+    branchName: string;
+    defaultBranch: boolean;
+};
+export type CreateBranchResult = {
+    branch: {
+        id: string;
+        name: string;
+    };
+};

package/dist/translate/queryBranchData.d.ts

@@ -0,0 +1,3 @@
+export type BranchQuery = {
+    branchNames: string[];
+};

package/dist/translate/queryFileData.d.ts

@@ -0,0 +1,42 @@
+export type FileDataQuery = {
+    sourceFiles?: {
+        fileId: string;
+        versionId: string;
+        branchId: string;
+    }[];
+    translatedFiles?: {
+        fileId: string;
+        versionId: string;
+        branchId: string;
+        locale: string;
+    }[];
+};
+export type FileDataResult = {
+    sourceFiles?: {
+        branchId: string;
+        fileId: string;
+        versionId: string;
+        fileName: string;
+        fileFormat: string;
+        dataFormat: string | null;
+        createdAt: string;
+        updatedAt: string;
+        approvalRequiredAt: string | null;
+        publishedAt: string | null;
+        locales: string[];
+        sourceLocale: string;
+    }[];
+    translatedFiles?: {
+        branchId: string;
+        fileId: string;
+        versionId: string;
+        fileFormat: string;
+        dataFormat: string | null;
+        createdAt: string;
+        updatedAt: string;
+        approvedAt: string | null;
+        publishedAt: string | null;
+        completedAt: string | null;
+        locale: string;
+    }[];
+};

package/dist/translate/submitUserEditDiffs.d.ts

@@ -2,11 +2,11 @@ export type SubmitUserEditDiff = {
     fileName: string;
     locale: string;
     diff: string;
-    versionId?: string;
-    fileId?: string;
+    branchId: string;
+    versionId: string;
+    fileId: string;
     localContent?: string;
 };
 export type SubmitUserEditDiffsPayload = {
-    projectId?: string;
     diffs: SubmitUserEditDiff[];
 };

package/dist/translate/utils/batch.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Splits an array into batches of a specified size.
+ * @param items - The array to split into batches
+ * @param batchSize - The maximum size of each batch
+ * @returns An array of batches
+ */
+export declare function createBatches<T>(items: T[], batchSize: number): T[][];
+/**
+ * Result of processing batches
+ */
+export interface BatchList<T> {
+    /** The items successfully processed across all batches */
+    data: T[];
+    /** The total number of items processed */
+    count: number;
+    /** The number of batches processed */
+    batchCount: number;
+}
+/**
+ * Options for batch processing
+ */
+export interface BatchProcessOptions {
+    /** Maximum number of items per batch (default: 100) */
+    batchSize?: number;
+    /** Whether to process batches in parallel (default: true) */
+    parallel?: boolean;
+}
+/**
+ * Processes items in batches using a provided processor function.
+ *
+ * @param items - The items to process
+ * @param processor - Async function that processes a single batch and returns items
+ * @param options - Optional configuration for batch processing
+ * @returns Promise that resolves to a BatchList containing all processed items
+ *
+ * @example
+ * ```typescript
+ * const result = await processBatches(
+ *   files,
+ *   async (batch) => {
+ *     const response = await uploadFiles(batch);
+ *     return response.uploadedFiles;
+ *   },
+ *   { batchSize: 100 }
+ * );
+ *
+ * console.log(result.data); // All items
+ * console.log(result.count); // Total count
+ * console.log(result.batchCount); // Number of batches processed
+ * ```
+ */
+export declare function processBatches<TInput, TOutput>(items: TInput[], processor: (batch: TInput[]) => Promise<TOutput[]>, options?: BatchProcessOptions): Promise<BatchList<TOutput>>;

package/dist/types-dir/api/branch.d.ts

@@ -0,0 +1,10 @@
+export type BranchDataResult = {
+    branches: {
+        id: string;
+        name: string;
+    }[];
+    defaultBranch: {
+        id: string;
+        name: string;
+    } | null;
+};

package/dist/types-dir/api/checkFileTranslations.d.ts

@@ -1,4 +1,3 @@
-import { CompletedFileTranslationData } from './file';
 export type FileTranslationQuery = {
     versionId: string;
     fileName?: string;
@@ -8,11 +7,9 @@ export type FileTranslationQuery = {
 export type CheckFileTranslationsOptions = {
     timeout?: number;
 };
-export type CheckFileTranslationsResult = {
-    translations: CompletedFileTranslationData[];
-};
 export type FileQuery = {
     fileId: string;
+    branchId?: string;
     versionId?: string;
 };
 export type FileQueryResult = {

package/dist/types-dir/api/downloadFileBatch.d.ts

@@ -1,24 +1,33 @@
 import { FileFormat } from './file';
+export type DownloadFileBatchRequest = {
+    fileId: string;
+    branchId?: string;
+    versionId?: string;
+    locale?: string;
+}[];
 export type DownloadFileBatchOptions = {
     timeout?: number;
 };
 export type BatchDownloadResult = {
-    translationId: string;
-    fileName?: string;
+    fileId: string;
+    fileName: string;
     success: boolean;
     content?: string;
     contentType?: string;
     error?: string;
 };
-type File = {
+export type DownloadedFile = {
     id: string;
-    fileName: string;
+    branchId: string;
+    fileId: string;
+    versionId: string;
+    locale?: string;
+    fileName?: string;
     data: string;
-    metadata: any;
+    metadata: Record<string, any>;
     fileFormat: FileFormat;
 };
 export type DownloadFileBatchResult = {
-    files: File[];
+    files: DownloadedFile[];
     count: number;
 };
-export {};

package/dist/types-dir/api/enqueueFiles.d.ts

@@ -1,5 +1,4 @@
-import { DataFormat, JsxChildren } from '../jsx/content';
-import { CompletedFileTranslationData, FileFormat } from './file';
+import { JsxChildren } from '../jsx/content';
 export type Updates = ({
     metadata: Record<string, any>;
 } & ({
@@ -12,21 +11,6 @@ export type Updates = ({
     dataFormat: 'I18NEXT';
     source: string;
 }))[];
-/**
- * File object structure for enqueueing files
- * @param content - Content of the file
- * @param fileName - Unique identifier for the file (such as the file path + file name)
- * @param fileFormat - The format of the file (JSON, MDX, MD, etc.)
- * @param formatMetadata - Optional metadata for the file, specific to the format of the file
- * @param dataFormat - Optional format of the data within the file
- */
-export type FileToTranslate = {
-    content: string;
-    fileName: string;
-    fileFormat: FileFormat;
-    formatMetadata?: Record<string, any>;
-    dataFormat?: DataFormat;
-};
 /**
  * Options for enqueueing files
  * @param publish - Whether to publish the files
@@ -52,11 +36,18 @@ export type EnqueueFilesOptions = {
 };
 export type RequiredEnqueueFilesOptions = EnqueueFilesOptions & Required<Pick<EnqueueFilesOptions, 'sourceLocale'>>;
 export type EnqueueFilesResult = {
-    translations: CompletedFileTranslationData[];
-    data: Record<string, {
-        fileName: string;
-        versionId: string;
-    }>;
+    jobData: {
+        [jobId: string]: {
+            sourceFileId: string;
+            fileId: string;
+            versionId: string;
+            branchId: string;
+            targetLocale: string;
+            projectId: string;
+            force: boolean;
+            modelProvider?: string;
+        };
+    };
     locales: string[];
     message: string;
 };

package/dist/types-dir/api/file.d.ts

@@ -1,3 +1,4 @@
+import { DataFormat } from 'src/types';
 import { Entry } from './entry';
 export type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML';
 export type FileMetadata = {
@@ -11,13 +12,34 @@ export type File = {
     source: Entry[] | string;
     fileMetadata: FileMetadata;
 };
-export type CompletedFileTranslationData = {
-    locale: string;
-    metadata: any;
+/**
+ * File object structure for uploading files
+ * @param content - Content of the file
+ * @param fileName - Unique identifier for the file (such as the file path + file name)
+ * @param fileFormat - The format of the file (JSON, MDX, MD, etc.)
+ * @param formatMetadata - Optional metadata for the file, specific to the format of the file
+ * @param dataFormat - Optional format of the data within the file
+ */
+export type FileToUpload = {
+    content: string;
+    formatMetadata?: Record<string, any>;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
+} & Omit<FileReference, 'branchId'> & {
+    branchId?: string;
+};
+/**
+ * File object structure for referencing files
+ * @param fileId - The ID of the file
+ * @param versionId - The ID of the version of the file
+ * @param branchId - The ID of the branch of the file
+ * @param locale - The locale of the file ()
+ */
+export type FileReference = {
     fileId: string;
-    fileName: string;
     versionId: string;
-    id: string;
-    isReady: boolean;
-    downloadUrl: string;
+    branchId: string;
+    fileName: string;
+    fileFormat: FileFormat;
+    dataFormat?: DataFormat;
 };

package/dist/types-dir/api/uploadFiles.d.ts

@@ -1,6 +1,9 @@
 import { DataFormat } from '../jsx/content';
-import { FileFormat } from './file';
+import { FileFormat, FileReference } from './file';
 export type FileUpload = {
+    branchId?: string;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
     content: string;
     fileName: string;
     fileFormat: FileFormat;
@@ -9,14 +12,6 @@ export type FileUpload = {
     versionId?: string;
     fileId?: string;
 };
-export type FileUploadRef = {
-    fileId: string;
-    versionId: string;
-    fileName: string;
-    fileFormat: FileFormat;
-    dataFormat?: DataFormat;
-    locale?: string;
-};
 export type UploadData = {
     data: {
         source: FileUpload;
@@ -31,7 +26,7 @@ export type UploadFilesOptions = {
     timeout?: number;
 };
 export type UploadFilesResponse = {
-    uploadedFiles: FileUploadRef[];
+    uploadedFiles: FileReference[];
     count: number;
     message: string;
 };

package/dist/types.d.ts

@@ -1,3 +1,5 @@
+import { DataFormat as DataFormat$1 } from 'src/types';
+
 type CustomMapping = Record<string, string | Partial<LocaleProperties>>;
 
 type LocaleProperties = {
@@ -129,18 +131,6 @@ type TranslationStatusResult = {
     localesWaitingForApproval: any[];
 };
 
-type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML';
-type CompletedFileTranslationData = {
-    locale: string;
-    metadata: any;
-    fileId: string;
-    fileName: string;
-    versionId: string;
-    id: string;
-    isReady: boolean;
-    downloadUrl: string;
-};
-
 type FileTranslationQuery = {
     versionId: string;
     fileName?: string;
@@ -150,22 +140,56 @@ type FileTranslationQuery = {
 type CheckFileTranslationsOptions = {
     timeout?: number;
 };
-type CheckFileTranslationsResult = {
-    translations: CompletedFileTranslationData[];
+
+type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML';
+/**
+ * File object structure for uploading files
+ * @param content - Content of the file
+ * @param fileName - Unique identifier for the file (such as the file path + file name)
+ * @param fileFormat - The format of the file (JSON, MDX, MD, etc.)
+ * @param formatMetadata - Optional metadata for the file, specific to the format of the file
+ * @param dataFormat - Optional format of the data within the file
+ */
+type FileToUpload = {
+    content: string;
+    formatMetadata?: Record<string, any>;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
+} & Omit<FileReference, 'branchId'> & {
+    branchId?: string;
+};
+/**
+ * File object structure for referencing files
+ * @param fileId - The ID of the file
+ * @param versionId - The ID of the version of the file
+ * @param branchId - The ID of the branch of the file
+ * @param locale - The locale of the file ()
+ */
+type FileReference = {
+    fileId: string;
+    versionId: string;
+    branchId: string;
+    fileName: string;
+    fileFormat: FileFormat;
+    dataFormat?: DataFormat$1;
 };
 
 type DownloadFileBatchOptions = {
     timeout?: number;
 };
-type File = {
+type DownloadedFile = {
     id: string;
-    fileName: string;
+    branchId: string;
+    fileId: string;
+    versionId: string;
+    locale?: string;
+    fileName?: string;
     data: string;
-    metadata: any;
+    metadata: Record<string, any>;
     fileFormat: FileFormat;
 };
 type DownloadFileBatchResult = {
-    files: File[];
+    files: DownloadedFile[];
     count: number;
 };
 
@@ -193,21 +217,6 @@ type Updates = ({
     dataFormat: 'I18NEXT';
     source: string;
 }))[];
-/**
- * File object structure for enqueueing files
- * @param content - Content of the file
- * @param fileName - Unique identifier for the file (such as the file path + file name)
- * @param fileFormat - The format of the file (JSON, MDX, MD, etc.)
- * @param formatMetadata - Optional metadata for the file, specific to the format of the file
- * @param dataFormat - Optional format of the data within the file
- */
-type FileToTranslate = {
-    content: string;
-    fileName: string;
-    fileFormat: FileFormat;
-    formatMetadata?: Record<string, any>;
-    dataFormat?: DataFormat;
-};
 /**
  * Options for enqueueing files
  * @param publish - Whether to publish the files
@@ -232,11 +241,18 @@ type EnqueueFilesOptions = {
     force?: boolean;
 };
 type EnqueueFilesResult = {
-    translations: CompletedFileTranslationData[];
-    data: Record<string, {
-        fileName: string;
-        versionId: string;
-    }>;
+    jobData: {
+        [jobId: string]: {
+            sourceFileId: string;
+            fileId: string;
+            versionId: string;
+            branchId: string;
+            targetLocale: string;
+            projectId: string;
+            force: boolean;
+            modelProvider?: string;
+        };
+    };
     locales: string[];
     message: string;
 };
@@ -304,6 +320,86 @@ type TranslationResult = RequestSuccess | TranslationError;
  */
 type TranslateManyResult = Array<TranslationResult>;
 
+type BranchDataResult = {
+    branches: {
+        id: string;
+        name: string;
+    }[];
+    defaultBranch: {
+        id: string;
+        name: string;
+    } | null;
+};
+
+type BranchQuery = {
+    branchNames: string[];
+};
+
+type FileDataQuery = {
+    sourceFiles?: {
+        fileId: string;
+        versionId: string;
+        branchId: string;
+    }[];
+    translatedFiles?: {
+        fileId: string;
+        versionId: string;
+        branchId: string;
+        locale: string;
+    }[];
+};
+type FileDataResult = {
+    sourceFiles?: {
+        branchId: string;
+        fileId: string;
+        versionId: string;
+        fileName: string;
+        fileFormat: string;
+        dataFormat: string | null;
+        createdAt: string;
+        updatedAt: string;
+        approvalRequiredAt: string | null;
+        publishedAt: string | null;
+        locales: string[];
+        sourceLocale: string;
+    }[];
+    translatedFiles?: {
+        branchId: string;
+        fileId: string;
+        versionId: string;
+        fileFormat: string;
+        dataFormat: string | null;
+        createdAt: string;
+        updatedAt: string;
+        approvedAt: string | null;
+        publishedAt: string | null;
+        completedAt: string | null;
+        locale: string;
+    }[];
+};
+
+type JobStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'unknown';
+type CheckJobStatusResult = {
+    jobId: string;
+    status: JobStatus;
+    error?: {
+        message: string;
+    };
+}[];
+
+type SubmitUserEditDiff = {
+    fileName: string;
+    locale: string;
+    diff: string;
+    branchId: string;
+    versionId: string;
+    fileId: string;
+    localContent?: string;
+};
+type SubmitUserEditDiffsPayload = {
+    diffs: SubmitUserEditDiff[];
+};
+
 /**
  * Transformations are made from a prefix and a suffix.
  */
@@ -406,4 +502,4 @@ type TranslationRequestConfig = {
 };
 
 export { HTML_CONTENT_PROPS };
-export type { CheckFileTranslationsOptions, CheckFileTranslationsResult, CompletedFileTranslationData, Content, ContentTranslationResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, Entry, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileFormat, FileToTranslate, FileTranslationQuery, FormatVariables, GTProp, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, Request, RetrievedTranslations, Transformation, TransformationPrefix, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };
+export type { BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, Entry, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FormatVariables, GTProp, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, Request, RetrievedTranslations, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "7.9.1",
+  "version": "8.0.0",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.cjs.min.cjs",
   "module": "dist/index.esm.min.mjs",
@@ -69,6 +69,11 @@
       "types": "./dist/types.d.ts",
       "require": "./dist/types.cjs.min.cjs",
       "import": "./dist/types.esm.min.mjs"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "require": "./dist/errors.cjs.min.cjs",
+      "import": "./dist/errors.esm.min.mjs"
     }
   },
   "typesVersions": {
@@ -81,6 +86,9 @@
       ],
       "types": [
         "./dist/types.d.ts"
+      ],
+      "errors": [
+        "./dist/errors.d.ts"
       ]
     }
   },
@@ -95,6 +103,9 @@
       ],
       "generaltranslation/types": [
         "/dist/types"
+      ],
+      "generaltranslation/errors": [
+        "/dist/errors"
       ]
     }
   },

package/dist/translate/checkFileTranslations.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/translate/checkSetupStatus.d.ts

@@ -1,8 +0,0 @@
-export type SetupJobStatus = 'queued' | 'processing' | 'completed' | 'failed';
-export type CheckSetupStatusResult = {
-    jobId: string;
-    status: SetupJobStatus;
-    error?: {
-        message: string;
-    };
-};

package/dist/translate/checkTranslationStatus.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/translate/downloadFile.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/translate/enqueueEntries.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/translate/fetchTranslations.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/translate/shouldSetupProject.d.ts

@@ -1,3 +0,0 @@
-export type ShouldSetupProjectResult = {
-    shouldSetupProject: boolean;
-};