generaltranslation 8.2.6 → 8.2.7

package/dist/locales/customLocaleMapping.d.ts

@@ -1,11 +0,0 @@
-import { LocaleProperties } from './getLocaleProperties';
-export type FullCustomMapping = Record<string, LocaleProperties>;
-export type CustomMapping = Record<string, string | Partial<LocaleProperties>>;
-export declare const getCustomProperty: (customMapping: CustomMapping, locale: string, property: keyof LocaleProperties) => string | undefined;
-/**
- * Checks if a given locale should use the canonical locale.
- * @param locale - The locale to check if it should use the canonical locale
- * @param customMapping - The custom mapping to use for checking if the locale should use the canonical locale
- * @returns True if the locale should use the canonical locale, false otherwise
- */
-export declare const shouldUseCanonicalLocale: (locale: string, customMapping: CustomMapping) => boolean;

package/dist/locales/determineLocale.d.ts

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

package/dist/locales/getLocaleDirection.d.ts

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

package/dist/locales/getLocaleEmoji.d.ts

@@ -1,2 +0,0 @@
-export declare const defaultEmoji = "\uD83C\uDF0D";
-export declare const emojis: Record<string, string>;

package/dist/locales/getLocaleName.d.ts

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

package/dist/locales/getLocaleProperties.d.ts

@@ -1,32 +0,0 @@
-import { CustomMapping } from './customLocaleMapping';
-export type LocaleProperties = {
-    code: string;
-    name: string;
-    nativeName: string;
-    languageCode: string;
-    languageName: string;
-    nativeLanguageName: string;
-    nameWithRegionCode: string;
-    nativeNameWithRegionCode: string;
-    regionCode: string;
-    regionName: string;
-    nativeRegionName: string;
-    scriptCode: string;
-    scriptName: string;
-    nativeScriptName: string;
-    maximizedCode: string;
-    maximizedName: string;
-    nativeMaximizedName: string;
-    minimizedCode: string;
-    minimizedName: string;
-    nativeMinimizedName: string;
-    emoji: string;
-};
-/**
- * Creates a set of custom locale properties from a custom mapping.
- *
- * @param lArray - An array of locale codes to search for in the custom mapping.
- * @param customMapping - Optional custom mapping of locale codes to names.
- * @returns A partial set of locale properties, or undefined if no custom mapping is provided.
- */
-export declare function createCustomLocaleProperties(lArray: string[], customMapping?: CustomMapping): Partial<LocaleProperties> | undefined;

package/dist/locales/getPluralForm.d.ts

@@ -1,9 +0,0 @@
-import { PluralType } from '../settings/plurals';
-/**
- * Given a number and a list of allowed plural forms, return the plural form that best fits the number.
- *
- * @param {number} n - The number to determine the plural form for.
- * @param {locales[]} forms - The allowed plural forms.
- * @returns {PluralType} The determined plural form, or an empty string if none fit.
- */
-export default function _getPluralForm(n: number, forms?: PluralType[], locales?: string[]): PluralType | '';

package/dist/locales/getRegionProperties.d.ts

@@ -1,7 +0,0 @@
-export type CustomRegionMapping = {
-    [region: string]: {
-        name?: string;
-        emoji?: string;
-        locale?: string;
-    };
-};

package/dist/locales/isSameDialect.d.ts

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

package/dist/locales/isSameLanguage.d.ts

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

package/dist/locales/isSupersetLocale.d.ts

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

package/dist/locales/isValidLocale.d.ts

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

package/dist/locales/requiresTranslation.d.ts

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

package/dist/locales/resolveAliasLocale.d.ts

@@ -1,8 +0,0 @@
-import { CustomMapping } from './customLocaleMapping';
-/**
- * Resolves the alias locale for a given locale.
- * @param locale - The locale to resolve the alias locale for
- * @param customMapping - The custom mapping to use for resolving the alias locale
- * @returns The alias locale
- */
-export declare function _resolveAliasLocale(locale: string, customMapping?: CustomMapping): string;

package/dist/locales/resolveCanonicalLocale.d.ts

@@ -1,8 +0,0 @@
-import { CustomMapping } from './customLocaleMapping';
-/**
- * Resolves the canonical locale for a given locale.
- * @param locale - The locale to resolve the canonical locale for
- * @param customMapping - The custom mapping to use for resolving the canonical locale
- * @returns The canonical locale
- */
-export declare function _resolveCanonicalLocale(locale: string, customMapping?: CustomMapping): string;

package/dist/logging/errors.d.ts

@@ -1,10 +0,0 @@
-export declare const translationTimeoutError: (timeout: number) => string;
-export declare const translationRequestFailedError: (error: string) => string;
-export declare const apiError: (status: number, statusText: string, error: string) => string;
-export declare const invalidAuthError = "GT Error: Invalid authentication.";
-export declare const noTargetLocaleProvidedError: (functionName: string) => string;
-export declare const noSourceLocaleProvidedError: (functionName: string) => string;
-export declare const noProjectIdProvidedError: (functionName: string) => string;
-export declare const noApiKeyProvidedError: (functionName: string) => string;
-export declare const invalidLocaleError: (locale: string) => string;
-export declare const invalidLocalesError: (locales: string[]) => string;

package/dist/logging/logger.d.ts

@@ -1,117 +0,0 @@
-/**
- * Comprehensive logging system for the General Translation library
- * Provides structured logging with multiple levels and configurable output
- */
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'off';
-export interface LogEntry {
-    level: LogLevel;
-    message: string;
-    timestamp: Date;
-    context?: string;
-    metadata?: Record<string, any>;
-}
-export interface LoggerConfig {
-    /** Minimum log level to output */
-    level: LogLevel;
-    /** Whether to include timestamps in log output */
-    includeTimestamp: boolean;
-    /** Whether to include context information */
-    includeContext: boolean;
-    /** Custom prefix for all log messages */
-    prefix?: string;
-    /** Whether to output to console (default: true) */
-    enableConsole: boolean;
-    /** Custom log handlers */
-    handlers?: LogHandler[];
-}
-export interface LogHandler {
-    handle(entry: LogEntry): void;
-}
-/**
- * Console log handler that outputs formatted messages to console
- */
-export declare class ConsoleLogHandler implements LogHandler {
-    private config;
-    constructor(config: LoggerConfig);
-    handle(entry: LogEntry): void;
-}
-/**
- * Main Logger class providing structured logging capabilities
- */
-export declare class Logger {
-    private config;
-    private handlers;
-    constructor(config?: Partial<LoggerConfig>);
-    /**
-     * Add a custom log handler
-     */
-    addHandler(handler: LogHandler): void;
-    /**
-     * Remove a log handler
-     */
-    removeHandler(handler: LogHandler): void;
-    /**
-     * Update logger configuration
-     */
-    configure(config: Partial<LoggerConfig>): void;
-    /**
-     * Check if a log level should be output based on current configuration
-     */
-    private shouldLog;
-    /**
-     * Internal logging method that creates log entries and passes them to handlers
-     */
-    private log;
-    /**
-     * Log a debug message
-     * Used for detailed diagnostic information, typically of interest only when diagnosing problems
-     */
-    debug(message: string, context?: string, metadata?: Record<string, any>): void;
-    /**
-     * Log an info message
-     * Used for general information about application operation
-     */
-    info(message: string, context?: string, metadata?: Record<string, any>): void;
-    /**
-     * Log a warning message
-     * Used for potentially problematic situations that don't prevent operation
-     */
-    warn(message: string, context?: string, metadata?: Record<string, any>): void;
-    /**
-     * Log an error message
-     * Used for error events that might still allow the application to continue
-     */
-    error(message: string, context?: string, metadata?: Record<string, any>): void;
-    /**
-     * Create a child logger with a specific context
-     */
-    child(context: string): ContextLogger;
-    /**
-     * Get current logger configuration
-     */
-    getConfig(): LoggerConfig;
-}
-/**
- * Context logger that automatically includes context information
- */
-export declare class ContextLogger {
-    private logger;
-    private context;
-    constructor(logger: Logger, context: string);
-    debug(message: string, metadata?: Record<string, any>): void;
-    info(message: string, metadata?: Record<string, any>): void;
-    warn(message: string, metadata?: Record<string, any>): void;
-    error(message: string, metadata?: Record<string, any>): void;
-    child(childContext: string): ContextLogger;
-}
-export declare const defaultLogger: Logger;
-export declare const debug: (message: string, context?: string, metadata?: Record<string, any>) => void;
-export declare const info: (message: string, context?: string, metadata?: Record<string, any>) => void;
-export declare const warn: (message: string, context?: string, metadata?: Record<string, any>) => void;
-export declare const error: (message: string, context?: string, metadata?: Record<string, any>) => void;
-export declare const fetchLogger: ContextLogger;
-export declare const validationLogger: ContextLogger;
-export declare const formattingLogger: ContextLogger;
-export declare const localeLogger: ContextLogger;
-export declare const gtInstanceLogger: ContextLogger;
-export { Logger as GTLogger };

package/dist/logging/warnings.d.ts

@@ -1,2 +0,0 @@
-export declare const formatI18nextWarning = "Warning: formatI18next is not currently supported but will be implemented in a future version. Use _formatMessageICU for current ICU message format support.";
-export declare const formatJsxWarning = "Warning: formatJsx is not currently supported but will be implemented in a future version. Use _formatMessageICU for current ICU message format support.";

package/dist/projects/getProjectData.d.ts

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

package/dist/settings/plurals.d.ts

@@ -1,3 +0,0 @@
-export declare const pluralForms: readonly ["singular", "plural", "dual", "zero", "one", "two", "few", "many", "other"];
-export type PluralType = (typeof pluralForms)[number];
-export declare function isAcceptedPluralForm(form: string): form is PluralType;

package/dist/settings/settings.d.ts

@@ -1,2 +0,0 @@
-export declare const libraryDefaultLocale: "en";
-export declare const defaultTimeout = 60000;

package/dist/settings/settingsUrls.d.ts

@@ -1,3 +0,0 @@
-export declare const defaultCacheUrl: "https://cdn.gtx.dev";
-export declare const defaultBaseUrl: "https://api2.gtx.dev";
-export declare const defaultRuntimeApiUrl: "https://runtime2.gtx.dev";

package/dist/translate/api.d.ts

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

package/dist/translate/awaitJobs.d.ts

@@ -1,19 +0,0 @@
-import { JobStatus } from './checkJobStatus';
-export type AwaitJobsOptions = {
-    /** Polling interval in seconds. Defaults to 5. */
-    pollingIntervalSeconds?: number;
-    /** Timeout in seconds. Defaults to 600 (10 minutes). If reached, resolves with whatever status is current. */
-    timeoutSeconds?: number;
-};
-export type JobResult = {
-    jobId: string;
-    status: JobStatus;
-    error?: {
-        message: string;
-    };
-};
-export type AwaitJobsResult = {
-    /** Whether all jobs completed (none still in progress). */
-    complete: boolean;
-    jobs: JobResult[];
-};

package/dist/translate/checkJobStatus.d.ts

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

package/dist/translate/createBranch.d.ts

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

package/dist/translate/createTag.d.ts

@@ -1,19 +0,0 @@
-export type CreateTagFileReference = {
-    fileId: string;
-    versionId: string;
-    branchId: string;
-};
-export type CreateTagOptions = {
-    tagId: string;
-    files: CreateTagFileReference[];
-    message?: string;
-};
-export type CreateTagResult = {
-    tag: {
-        id: string;
-        tagId: string;
-        message: string | null;
-        createdAt: string;
-        updatedAt: string;
-    };
-};

package/dist/translate/downloadFileBatch.d.ts

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

package/dist/translate/enqueueFiles.d.ts

@@ -1,8 +0,0 @@
-export type EnqueueOptions = {
-    sourceLocale?: string;
-    targetLocales: string[];
-    requireApproval?: boolean;
-    modelProvider?: string;
-    force?: boolean;
-    timeout?: number;
-};

package/dist/translate/getOrphanedFiles.d.ts

@@ -1,8 +0,0 @@
-export type OrphanedFile = {
-    fileId: string;
-    versionId: string;
-    fileName: string;
-};
-export type GetOrphanedFilesResult = {
-    orphanedFiles: OrphanedFile[];
-};

package/dist/translate/processFileMoves.d.ts

@@ -1,25 +0,0 @@
-export type MoveMapping = {
-    oldFileId: string;
-    newFileId: string;
-    newFileName: string;
-};
-export type MoveResult = {
-    oldFileId: string;
-    newFileId: string;
-    success: boolean;
-    newSourceFileId?: string;
-    clonedTranslationsCount?: number;
-    error?: string;
-};
-export type ProcessMovesResponse = {
-    results: MoveResult[];
-    summary: {
-        total: number;
-        succeeded: number;
-        failed: number;
-    };
-};
-export type ProcessMovesOptions = {
-    timeout?: number;
-    branchId?: string;
-};

package/dist/translate/publishFiles.d.ts

@@ -1,17 +0,0 @@
-export type PublishFileEntry = {
-    fileId: string;
-    versionId: string;
-    branchId?: string;
-    publish: boolean;
-    fileName?: string;
-};
-export type PublishFilesResult = {
-    results: {
-        fileId: string;
-        versionId: string;
-        locale?: string;
-        branchId: string;
-        success: boolean;
-        error?: string;
-    }[];
-};

package/dist/translate/queryBranchData.d.ts

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

package/dist/translate/queryFileData.d.ts

@@ -1,42 +0,0 @@
-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/querySourceFile.d.ts

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

package/dist/translate/setupProject.d.ts

@@ -1,11 +0,0 @@
-export type SetupProjectResult = {
-    setupJobId: string;
-    status: 'queued';
-} | {
-    status: 'completed';
-};
-export type SetupProjectOptions = {
-    force?: boolean;
-    locales?: string[];
-    timeoutMs?: number;
-};

package/dist/translate/submitUserEditDiffs.d.ts

@@ -1,12 +0,0 @@
-export type SubmitUserEditDiff = {
-    fileName: string;
-    locale: string;
-    diff: string;
-    branchId: string;
-    versionId: string;
-    fileId: string;
-    localContent: string;
-};
-export type SubmitUserEditDiffsPayload = {
-    diffs: SubmitUserEditDiff[];
-};

package/dist/translate/translateMany.d.ts

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

package/dist/translate/uploadSourceFiles.d.ts

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

package/dist/translate/uploadTranslations.d.ts

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

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

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

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

@@ -1,52 +0,0 @@
-/**
- * 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/translate/utils/fetchWithTimeout.d.ts

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

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

@@ -1,2 +0,0 @@
-import { TranslationRequestConfig } from '../../types';
-export default function generateRequestHeaders(config: TranslationRequestConfig, excludeContentType?: boolean): Record<string, string>;

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

@@ -1 +0,0 @@
-export default function handleFetchError(error: unknown, timeout: number): never;

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

@@ -1 +0,0 @@
-export default function validateResponse(response: Response): Promise<void>;

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

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

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

@@ -1,37 +0,0 @@
-export type FileTranslationQuery = {
-    versionId: string;
-    fileName?: string;
-    fileId?: string;
-    locale: string;
-};
-export type CheckFileTranslationsOptions = {
-    timeout?: number;
-};
-export type FileQuery = {
-    fileId: string;
-    branchId?: string;
-    versionId?: string;
-};
-export type FileQueryResult = {
-    sourceFile: {
-        id: string;
-        fileId: string;
-        versionId: string;
-        sourceLocale: string;
-        fileName: string;
-        fileFormat: string;
-        dataFormat: string | null;
-        createdAt: string;
-        updatedAt: string;
-        approvalRequiredAt: string | null;
-        locales: string[];
-    };
-    translations: {
-        locale: string;
-        completedAt: string | null;
-        approvedAt: string | null;
-        publishedAt: string | null;
-        createdAt: string | null;
-        updatedAt: string | null;
-    }[];
-};

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

@@ -1,3 +0,0 @@
-export type DownloadFileOptions = {
-    timeout?: number;
-};

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

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