generaltranslation 8.2.12 → 8.2.13

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

@@ -0,0 +1,70 @@
+import { DataFormat, JsxChildren } from '../jsx/content';
+type UpdateMetadata = {
+    id?: string;
+    hash?: string;
+    context?: string;
+    maxChars?: number;
+    dataFormat?: DataFormat;
+    actionType?: 'standard' | 'fast' | string;
+    staticId?: string;
+    format?: string;
+    filePaths?: string[];
+    sourceCode?: unknown;
+    contextDeriveExpr?: unknown;
+    _contextDeriveExpr?: unknown;
+    [key: string]: unknown;
+};
+export type Updates = ({
+    metadata: UpdateMetadata;
+} & ({
+    dataFormat: 'JSX';
+    source: JsxChildren;
+} | {
+    dataFormat: 'ICU';
+    source: string;
+} | {
+    dataFormat: 'I18NEXT';
+    source: string;
+} | {
+    dataFormat: 'STRING';
+    source: string;
+}))[];
+/**
+ * Options for enqueueing files
+ * @param requireApproval - Whether to require approval for the files.
+ * @param description - Optional description for the project.
+ * @param sourceLocale - The project's source locale.
+ * @param targetLocales - The locales to translate the files to.
+ * @param version - Optional custom version ID to specify.
+ * @param timeout - Optional timeout for the request.
+ * @param modelProvider - Optional model provider to use.
+ */
+export type EnqueueFilesOptions = {
+    requireApproval?: boolean;
+    description?: string;
+    sourceLocale?: string;
+    targetLocales: string[];
+    version?: string;
+    _versionId?: string;
+    timeout?: number;
+    modelProvider?: string;
+    force?: boolean;
+};
+export type RequiredEnqueueFilesOptions = EnqueueFilesOptions & Required<Pick<EnqueueFilesOptions, 'sourceLocale'>>;
+export type EnqueueFilesResult = {
+    jobData: {
+        [jobId: string]: {
+            sourceFileId: string;
+            fileId: string;
+            versionId: string;
+            branchId: string;
+            targetLocale: string;
+            projectId: string;
+            force: boolean;
+            modelProvider?: string;
+        };
+    };
+    locales: string[];
+    message: string;
+};
+export {};

package/dist/types-dir/api/enqueueFiles.js

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

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

@@ -0,0 +1,39 @@
+import { Content, DataFormat } from '../../types';
+/**
+ * ActionType is the type of action to perform on the request.
+ *
+ * @param fast - The fast action type (mini model).
+ */
+export type ActionType = 'fast';
+/**
+ * EntryMetadata is the metadata for a GTRequest.
+ *
+ * @param context - The context of the request.
+ * @param id - The ID of the request.
+ * @param maxChars - The maxChars of the request.
+ * @param hash - The hash of the request.
+ */
+export type EntryMetadata = {
+    id?: string;
+    hash?: string;
+    context?: string;
+    maxChars?: number;
+    dataFormat?: DataFormat;
+    actionType?: ActionType;
+};
+export type RuntimeTranslateManyOptions = {
+    sourceLocale?: string;
+    modelProvider?: string;
+    [key: string]: unknown;
+};
+export type TranslateOptions = RuntimeTranslateManyOptions & {
+    targetLocale: string;
+};
+/**
+ * TranslateManyEntry is the input type for translateMany.
+ * Can be a plain string or an object with source and entry metadata fields.
+ */
+export type TranslateManyEntry = string | {
+    source: Content;
+    metadata?: EntryMetadata;
+};

package/dist/types-dir/api/entry.js

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

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

@@ -0,0 +1,12 @@
+import type { Content } from '../jsx/content';
+export type FetchTranslationsOptions = {
+    timeout?: number;
+};
+export type RetrievedTranslation = {
+    locale: string;
+    translation: Content;
+};
+export type RetrievedTranslations = RetrievedTranslation[];
+export type FetchTranslationsResult = {
+    translations: RetrievedTranslations;
+};

package/dist/types-dir/api/fetchTranslations.js

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

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

@@ -0,0 +1,57 @@
+import { DataFormat } from '../jsx/content';
+import { Updates } from './enqueueFiles';
+import type { JsonObject } from './json';
+export type FileFormat = 'GTJSON' | 'JSON' | 'PO' | 'POT' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'TWILIO_CONTENT_JSON';
+/**
+ * Metadata for files or entries.
+ */
+export type FormatMetadata = JsonObject | Updates[number]['metadata'];
+/**
+ * File object structure for uploading files.
+ * @see {@link FileReferenceOptionalBranchId}
+ * @property {string} content - Content of the file.
+ * @property {string} locale - The locale of the file (e.g. 'en', 'de', 'es', etc.)
+ * @property {FormatMetadata} [formatMetadata] - Optional metadata for the file, specific to the format of the file
+ * @property {string} [incomingBranchId] - The ID of the incoming branch of the file.
+ * @property {string} [checkedOutBranchId] - The ID of the checked-out branch of the file.
+ */
+export type FileToUpload = Omit<FileReference, 'branchId'> & {
+    content: string;
+    locale: string;
+    transformFormat?: FileFormat;
+    formatMetadata?: FormatMetadata;
+    branchId?: string;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
+};
+/**
+ * File object structure for referencing files.
+ * @property {string} fileId - The ID of the file.
+ * @property {string} versionId - The ID of the version of the file
+ * @property {string} branchId - The ID of the branch of the file
+ * @property {string} locale - The locale of the file (e.g. 'en', 'de', 'es', etc.)
+ * @property {string} fileName - The name of the file.
+ * @property {FileFormat} fileFormat - The format of the file (JSON, MDX, MD, etc.).
+ * @property {DataFormat} [dataFormat] - Optional format of the data within the file.
+ */
+export type FileReference = {
+    fileId: string;
+    versionId: string;
+    branchId: string;
+    fileName: string;
+    fileFormat: FileFormat;
+    transformFormat?: FileFormat;
+    dataFormat?: DataFormat;
+};
+/**
+ * File reference object structure for referencing files.
+ * @see {@link FileReference}
+ * @property {string} [branchId] - The ID of the branch of the file
+ */
+export type FileReferenceIds = Omit<FileReference, 'branchId' | 'fileName' | 'fileFormat' | 'dataFormat'> & {
+    branchId?: string;
+    fileName?: string;
+    fileFormat?: FileFormat;
+    transformFormat?: FileFormat;
+    dataFormat?: DataFormat;
+};

package/dist/types-dir/api/file.js

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

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

@@ -0,0 +1,5 @@
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
+export type JsonObject = {
+    [key: string]: JsonValue;
+};

package/dist/types-dir/api/json.js

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

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

@@ -0,0 +1,7 @@
+export type ProjectData = {
+    id: string;
+    name: string;
+    orgId: string;
+    defaultLocale: string;
+    currentLocales: string[];
+};

package/dist/types-dir/api/project.js

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

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

@@ -0,0 +1,34 @@
+import { I18nextMessage, IcuMessage, JsxChildren, StringMessage } from '../jsx/content';
+/**
+ * TranslationResultReference is used to store the reference for a translation result.
+ */
+export type TranslationResultReference = {
+    id?: string;
+    hash: string;
+};
+/**
+ * TypedResult is a union type that represents the different types of translations that can be returned.
+ */
+export type TypedResult = {
+    translation: JsxChildren;
+    dataFormat: 'JSX';
+} | {
+    translation: I18nextMessage | IcuMessage | StringMessage;
+    dataFormat: 'ICU' | 'I18NEXT' | 'STRING';
+};
+/**
+ * RequestError is a type that represents an error that occurred during a translation request.
+ */
+export type TranslationError = {
+    success: false;
+    error: string;
+    code: number;
+};
+/**
+ * RequestSuccess is a type that represents a successful translation request.
+ */
+export type RequestSuccess = TypedResult & {
+    success: true;
+    locale: string;
+};
+export type TranslationResult = RequestSuccess | TranslationError;

package/dist/types-dir/api/translate.js

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

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

@@ -0,0 +1,5 @@
+import { TranslationResult } from './translate';
+/**
+ * BatchTranslationResult is the result of a batch translation request.
+ */
+export type TranslateManyResult = TranslationResult[];

package/dist/types-dir/api/translateMany.js

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

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

@@ -0,0 +1,9 @@
+export type TranslationStatusResult = {
+    count: number;
+    availableLocales: string[];
+    locales: string[];
+    localesWaitingForApproval: string[];
+};
+export type CheckTranslationStatusOptions = {
+    timeout?: number;
+};

package/dist/types-dir/api/translationStatus.js

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

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

@@ -0,0 +1,44 @@
+import { DataFormat } from '../jsx/content';
+import { FileFormat, FileReference, type FormatMetadata } from './file';
+/**
+ * Metadata stored alongside GTJSON file entries.
+ * Keys correspond to the entry id/hash in the GTJSON body.
+ */
+export type GTJsonFormatMetadata = Record<string, {
+    context?: string;
+    id?: string;
+    domain?: string;
+    maxChars?: number;
+    dataFormat?: 'JSX' | 'ICU' | 'I18NEXT';
+    requestVersion?: number;
+    approved_at?: string | null;
+    approved_by?: string | null;
+    hash?: string;
+    staticId?: string;
+    filePaths?: string[];
+}>;
+export type FileUpload = {
+    branchId?: string;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
+    content: string;
+    fileName: string;
+    fileFormat: FileFormat;
+    transformFormat?: FileFormat;
+    dataFormat?: DataFormat;
+    locale: string;
+    formatMetadata?: GTJsonFormatMetadata | FormatMetadata;
+    versionId?: string;
+    fileId?: string;
+};
+export type UploadFilesOptions = {
+    sourceLocale: string;
+    modelProvider?: string;
+    timeout?: number;
+};
+export type UploadFilesResponse = {
+    uploadedFiles: FileReference[];
+    count: number;
+    message: string;
+};
+export type RequiredUploadFilesOptions = UploadFilesOptions & Required<Pick<UploadFilesOptions, 'sourceLocale'>>;

package/dist/types-dir/api/uploadFiles.js

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

package/dist/types-dir/jsx/content.d.ts

@@ -0,0 +1,61 @@
+import { Variable } from './variables';
+/**
+ * Map of data-_gt properties to their corresponding React props
+ */
+export declare const HTML_CONTENT_PROPS: {
+    readonly pl: "placeholder";
+    readonly ti: "title";
+    readonly alt: "alt";
+    readonly arl: "aria-label";
+    readonly arb: "aria-labelledby";
+    readonly ard: "aria-describedby";
+};
+export type HtmlContentPropKeysRecord = Partial<Record<keyof typeof HTML_CONTENT_PROPS, string>>;
+export type HtmlContentPropValuesRecord = Partial<Record<(typeof HTML_CONTENT_PROPS)[keyof typeof HTML_CONTENT_PROPS], string>>;
+/**
+ * GTProp is an internal property used to contain data for translating and rendering elements.
+ * note, transformations are only read on the server side if they are 'plural' or 'branch'
+ */
+export type GTProp = {
+    b?: Record<string, JsxChildren>;
+    t?: 'p' | 'b';
+} & HtmlContentPropKeysRecord;
+export type JsxElement = {
+    t?: string;
+    i?: number;
+    d?: GTProp;
+    c?: JsxChildren;
+};
+export type JsxChild = string | JsxElement | Variable;
+/**
+ * The format of the string content
+ */
+export type StringFormat = 'ICU' | 'I18NEXT' | 'STRING';
+/**
+ * The format of the content.
+ */
+export type DataFormat = 'JSX' | StringFormat;
+/**
+ * String format content.
+ */
+export type StringContent = IcuMessage | StringMessage | I18nextMessage;
+/**
+ * A content type representing JSX, ICU, and I18next messages.
+ */
+export type Content = JsxChildren | StringContent;
+/**
+ * A content type representing JSX elements.
+ */
+export type JsxChildren = JsxChild | JsxChild[];
+/**
+ * A content type representing ICU messages.
+ */
+export type IcuMessage = string;
+/**
+ * A content type representing I18next messages.
+ */
+export type I18nextMessage = string;
+/**
+ * A content type representing plain strings.
+ */
+export type StringMessage = string;

package/dist/types-dir/jsx/content.js

@@ -0,0 +1,11 @@
+/**
+ * Map of data-_gt properties to their corresponding React props
+ */
+export var HTML_CONTENT_PROPS = {
+    pl: 'placeholder',
+    ti: 'title',
+    alt: 'alt',
+    arl: 'aria-label',
+    arb: 'aria-labelledby',
+    ard: 'aria-describedby',
+};

package/dist/types-dir/jsx/variables.d.ts

@@ -0,0 +1,9 @@
+export type VariableType = 'v' | 'n' | 'd' | 'c' | 'rt';
+/**
+ * Variables are used to store the variable name and type.
+ */
+export type Variable = {
+    k: string;
+    i?: number;
+    v?: VariableType;
+};

package/dist/types-dir/jsx/variables.js

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

package/dist/types-dir/transformations.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Transformations are made from a prefix and a suffix.
+ */
+export type Transformation = BaseTransformation | `${BaseTransformation}-${InjectionType}`;
+export type BaseTransformation = 'translate-client' | 'translate-server' | 'translate-runtime' | 'variable-variable' | 'variable-currency' | 'variable-datetime' | 'variable-number' | 'variable-relative-time' | 'plural' | 'branch' | 'derive';
+export type TransformationPrefix = 'translate' | 'variable' | 'plural' | 'branch' | 'fragment' | 'derive';
+export type VariableTransformationSuffix = 'variable' | 'number' | 'datetime' | 'currency' | 'relative-time';
+export type InjectionType = 'automatic' | 'manual';

package/dist/types-dir/transformations.js

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

package/dist/types.d.cts

@@ -1,2 +1,2 @@
-import { $ as FileReference, A as BranchDataResult, At as Variable, B as FileUpload, C as ProcessMovesOptions, Ct as IcuMessage, D as FileDataQuery, Dt as StringContent, E as OrphanedFile, Et as JsxElement, F as DownloadFileOptions, G as FetchTranslationsOptions, I as PublishFileEntry, J as DownloadFileBatchOptions, K as FetchTranslationsResult, L as PublishFilesResult, M as TranslationError, Mt as LocaleProperties, N as TranslationResult, Nt as CustomMapping, O as FileDataResult, Ot as StringFormat, P as TranslationResultReference, Q as FileFormat, R as EnqueueEntriesOptions, S as MoveResult, St as I18nextMessage, T as GetOrphanedFilesResult, Tt as JsxChildren, U as CreateTagOptions, W as CreateTagResult, X as DownloadFileBatchResult, Z as DownloadedFile, _ as AwaitJobsResult, _t as DataFormat, a as Metadata, at as CheckFileTranslationsOptions, b as JobStatus, bt as HtmlContentPropKeysRecord, c as Update, ct as FileTranslationQuery, d as Transformation, dt as ActionType, f as TransformationPrefix, ft as EntryMetadata, g as AwaitJobsOptions, gt as Content, h as SubmitUserEditDiffsPayload, i as JsxTranslationResult, it as Updates, j as TranslateManyResult, jt as VariableType, k as BranchQuery, kt as StringMessage, l as _Content, lt as TranslationStatusResult, m as SubmitUserEditDiff, mt as TranslateManyEntry, n as FormatVariables, nt as EnqueueFilesOptions, o as Request, p as VariableTransformationSuffix, q as RetrievedTranslations, r as IcuTranslationResult, rt as EnqueueFilesResult, s as TranslationRequestConfig, t as ContentTranslationResult, tt as FileToUpload, u as InjectionType, ut as HashMetadata, v as JobResult, vt as GTProp, w as ProcessMovesResponse, wt as JsxChild, x as MoveMapping, xt as HtmlContentPropValuesRecord, y as CheckJobStatusResult, yt as HTML_CONTENT_PROPS, z as EnqueueEntriesResult } from "./types-V5rqd1WR.cjs";
-export { AwaitJobsOptions, AwaitJobsResult, BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CreateTagOptions, CreateTagResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, GetOrphanedFilesResult, HTML_CONTENT_PROPS, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, InjectionType, JobResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, MoveMapping, MoveResult, OrphanedFile, ProcessMovesOptions, ProcessMovesResponse, PublishFileEntry, PublishFilesResult, Request, RetrievedTranslations, StringContent, StringFormat, StringMessage, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyEntry, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };
+import { $ as FileReference, A as BranchDataResult, At as StringContent, B as FileUpload, C as ProcessMovesOptions, Ct as HtmlContentPropKeysRecord, D as FileDataQuery, Dt as JsxChild, E as OrphanedFile, Et as IcuMessage, F as DownloadFileOptions, Ft as LocaleProperties, G as FetchTranslationsOptions, I as PublishFileEntry, It as CustomMapping, J as DownloadFileBatchOptions, K as FetchTranslationsResult, L as PublishFilesResult, M as TranslationError, Mt as StringMessage, N as TranslationResult, Nt as Variable, O as FileDataResult, Ot as JsxChildren, P as TranslationResultReference, Pt as VariableType, Q as FileFormat, R as EnqueueEntriesOptions, S as MoveResult, St as HTML_CONTENT_PROPS, T as GetOrphanedFilesResult, Tt as I18nextMessage, U as CreateTagOptions, W as CreateTagResult, X as DownloadFileBatchResult, Z as DownloadedFile, _ as AwaitJobsResult, _t as TranslateManyEntry, a as Metadata, at as CheckFileTranslationsOptions, b as JobStatus, bt as DataFormat, c as Update, ct as FileTranslationQuery, d as Transformation, dt as JsonValue, f as TransformationPrefix, ft as TranslationStatusResult, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, ht as EntryMetadata, i as JsxTranslationResult, it as Updates, j as TranslateManyResult, jt as StringFormat, k as BranchQuery, kt as JsxElement, l as _Content, lt as JsonObject, m as SubmitUserEditDiff, mt as ActionType, n as FormatVariables, nt as EnqueueFilesOptions, o as Request, p as VariableTransformationSuffix, pt as HashMetadata, q as RetrievedTranslations, r as IcuTranslationResult, rt as EnqueueFilesResult, s as TranslationRequestConfig, t as ContentTranslationResult, tt as FileToUpload, u as InjectionType, ut as JsonPrimitive, v as JobResult, w as ProcessMovesResponse, wt as HtmlContentPropValuesRecord, x as MoveMapping, xt as GTProp, y as CheckJobStatusResult, yt as Content, z as EnqueueEntriesResult } from "./types-Bf8_Apq_.cjs";
+export { AwaitJobsOptions, AwaitJobsResult, BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CreateTagOptions, CreateTagResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, GetOrphanedFilesResult, HTML_CONTENT_PROPS, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, InjectionType, JobResult, JobStatus, JsonObject, JsonPrimitive, JsonValue, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, MoveMapping, MoveResult, OrphanedFile, ProcessMovesOptions, ProcessMovesResponse, PublishFileEntry, PublishFilesResult, Request, RetrievedTranslations, StringContent, StringFormat, StringMessage, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyEntry, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };

package/dist/types.d.mts

@@ -1,2 +1,2 @@
-import { $ as FileReference, A as BranchDataResult, At as Variable, B as FileUpload, C as ProcessMovesOptions, Ct as IcuMessage, D as FileDataQuery, Dt as StringContent, E as OrphanedFile, Et as JsxElement, F as DownloadFileOptions, G as FetchTranslationsOptions, I as PublishFileEntry, J as DownloadFileBatchOptions, K as FetchTranslationsResult, L as PublishFilesResult, M as TranslationError, Mt as LocaleProperties, N as TranslationResult, Nt as CustomMapping, O as FileDataResult, Ot as StringFormat, P as TranslationResultReference, Q as FileFormat, R as EnqueueEntriesOptions, S as MoveResult, St as I18nextMessage, T as GetOrphanedFilesResult, Tt as JsxChildren, U as CreateTagOptions, W as CreateTagResult, X as DownloadFileBatchResult, Z as DownloadedFile, _ as AwaitJobsResult, _t as DataFormat, a as Metadata, at as CheckFileTranslationsOptions, b as JobStatus, bt as HtmlContentPropKeysRecord, c as Update, ct as FileTranslationQuery, d as Transformation, dt as ActionType, f as TransformationPrefix, ft as EntryMetadata, g as AwaitJobsOptions, gt as Content, h as SubmitUserEditDiffsPayload, i as JsxTranslationResult, it as Updates, j as TranslateManyResult, jt as VariableType, k as BranchQuery, kt as StringMessage, l as _Content, lt as TranslationStatusResult, m as SubmitUserEditDiff, mt as TranslateManyEntry, n as FormatVariables, nt as EnqueueFilesOptions, o as Request, p as VariableTransformationSuffix, q as RetrievedTranslations, r as IcuTranslationResult, rt as EnqueueFilesResult, s as TranslationRequestConfig, t as ContentTranslationResult, tt as FileToUpload, u as InjectionType, ut as HashMetadata, v as JobResult, vt as GTProp, w as ProcessMovesResponse, wt as JsxChild, x as MoveMapping, xt as HtmlContentPropValuesRecord, y as CheckJobStatusResult, yt as HTML_CONTENT_PROPS, z as EnqueueEntriesResult } from "./types-BsGsgJWF.mjs";
-export { AwaitJobsOptions, AwaitJobsResult, BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CreateTagOptions, CreateTagResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, GetOrphanedFilesResult, HTML_CONTENT_PROPS, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, InjectionType, JobResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, MoveMapping, MoveResult, OrphanedFile, ProcessMovesOptions, ProcessMovesResponse, PublishFileEntry, PublishFilesResult, Request, RetrievedTranslations, StringContent, StringFormat, StringMessage, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyEntry, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };
+import { $ as FileReference, A as BranchDataResult, At as StringContent, B as FileUpload, C as ProcessMovesOptions, Ct as HtmlContentPropKeysRecord, D as FileDataQuery, Dt as JsxChild, E as OrphanedFile, Et as IcuMessage, F as DownloadFileOptions, Ft as LocaleProperties, G as FetchTranslationsOptions, I as PublishFileEntry, It as CustomMapping, J as DownloadFileBatchOptions, K as FetchTranslationsResult, L as PublishFilesResult, M as TranslationError, Mt as StringMessage, N as TranslationResult, Nt as Variable, O as FileDataResult, Ot as JsxChildren, P as TranslationResultReference, Pt as VariableType, Q as FileFormat, R as EnqueueEntriesOptions, S as MoveResult, St as HTML_CONTENT_PROPS, T as GetOrphanedFilesResult, Tt as I18nextMessage, U as CreateTagOptions, W as CreateTagResult, X as DownloadFileBatchResult, Z as DownloadedFile, _ as AwaitJobsResult, _t as TranslateManyEntry, a as Metadata, at as CheckFileTranslationsOptions, b as JobStatus, bt as DataFormat, c as Update, ct as FileTranslationQuery, d as Transformation, dt as JsonValue, f as TransformationPrefix, ft as TranslationStatusResult, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, ht as EntryMetadata, i as JsxTranslationResult, it as Updates, j as TranslateManyResult, jt as StringFormat, k as BranchQuery, kt as JsxElement, l as _Content, lt as JsonObject, m as SubmitUserEditDiff, mt as ActionType, n as FormatVariables, nt as EnqueueFilesOptions, o as Request, p as VariableTransformationSuffix, pt as HashMetadata, q as RetrievedTranslations, r as IcuTranslationResult, rt as EnqueueFilesResult, s as TranslationRequestConfig, t as ContentTranslationResult, tt as FileToUpload, u as InjectionType, ut as JsonPrimitive, v as JobResult, w as ProcessMovesResponse, wt as HtmlContentPropValuesRecord, x as MoveMapping, xt as GTProp, y as CheckJobStatusResult, yt as Content, z as EnqueueEntriesResult } from "./types-AHtYZIP-.mjs";
+export { AwaitJobsOptions, AwaitJobsResult, BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CreateTagOptions, CreateTagResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, GetOrphanedFilesResult, HTML_CONTENT_PROPS, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, InjectionType, JobResult, JobStatus, JsonObject, JsonPrimitive, JsonValue, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, MoveMapping, MoveResult, OrphanedFile, ProcessMovesOptions, ProcessMovesResponse, PublishFileEntry, PublishFilesResult, Request, RetrievedTranslations, StringContent, StringFormat, StringMessage, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyEntry, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };

package/dist/types.d.ts

@@ -0,0 +1,129 @@
+import type { LocaleProperties } from './locales/getLocaleProperties';
+import type { Variable, VariableType } from './types-dir/jsx/variables';
+import { type IcuMessage, type I18nextMessage, type StringMessage, type StringContent, type JsxChildren, type JsxChild, type JsxElement, type GTProp, type HtmlContentPropKeysRecord, type HtmlContentPropValuesRecord, HTML_CONTENT_PROPS, type DataFormat, type Content, type StringFormat } from './types-dir/jsx/content';
+import type { ActionType, EntryMetadata, TranslateManyEntry } from './types-dir/api/entry';
+import type { HashMetadata } from './id/types';
+export type { TranslationStatusResult } from './types-dir/api/translationStatus';
+export type { JsonObject, JsonPrimitive, JsonValue, } from './types-dir/api/json';
+export { IcuMessage, StringMessage, I18nextMessage, StringContent, JsxChildren, JsxChild, JsxElement, GTProp, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, HTML_CONTENT_PROPS, Variable, VariableType, LocaleProperties, DataFormat, ActionType as EntryActionType, EntryMetadata, TranslateManyEntry, Content, StringFormat, HashMetadata, };
+export type { FileTranslationQuery, CheckFileTranslationsOptions, } from './types-dir/api/checkFileTranslations';
+export type { DownloadFileBatchOptions, DownloadFileBatchResult, } from './types-dir/api/downloadFileBatch';
+export type { FetchTranslationsOptions, FetchTranslationsResult, RetrievedTranslations, } from './types-dir/api/fetchTranslations';
+export type { EnqueueFilesOptions, EnqueueFilesResult, Updates, } from './types-dir/api/enqueueFiles';
+export type { CreateTagOptions, CreateTagResult } from './translate/createTag';
+export type { FileToUpload } from './types-dir/api/file';
+export type { FileUpload } from './types-dir/api/uploadFiles';
+export type { EnqueueEntriesOptions, EnqueueEntriesResult, } from './types-dir/api/enqueueEntries';
+export type { FileReference } from './types-dir/api/file';
+export type { PublishFileEntry, PublishFilesResult, } from './translate/publishFiles';
+export type { DownloadedFile } from './types-dir/api/downloadFileBatch';
+export type { DownloadFileOptions } from './types-dir/api/downloadFile';
+export type { FileFormat } from './types-dir/api/file';
+export type { TranslateManyResult } from './types-dir/api/translateMany';
+export type { TranslationResult, TranslationError, TranslationResultReference, } from './types-dir/api/translate';
+export type { BranchDataResult } from './types-dir/api/branch';
+export type { BranchQuery } from './translate/queryBranchData';
+export type { FileDataQuery, FileDataResult } from './translate/queryFileData';
+export type { OrphanedFile, GetOrphanedFilesResult, } from './translate/getOrphanedFiles';
+export type { MoveMapping, MoveResult, ProcessMovesResponse, ProcessMovesOptions, } from './translate/processFileMoves';
+export type { JobStatus, CheckJobStatusResult, } from './translate/checkJobStatus';
+export type { AwaitJobsOptions, AwaitJobsResult, JobResult, } from './translate/awaitJobs';
+export type { SubmitUserEditDiff, SubmitUserEditDiffsPayload, } from './translate/submitUserEditDiffs';
+/**
+ * @deprecated Use {@link Content} instead.
+ */
+export type _Content = string | Array<string | Variable>;
+export type { Transformation, TransformationPrefix, VariableTransformationSuffix, InjectionType, } from './types-dir/transformations';
+export type Metadata = {
+    maxChars?: number;
+    context?: string;
+    id?: string;
+    hash?: string;
+    format?: string;
+    dataFormat?: DataFormat;
+    sourceLocale?: string;
+    actionType?: 'standard' | 'fast' | string;
+    filePaths?: string[];
+    [key: string]: unknown;
+};
+export type FormatVariables = Record<string, string | number | boolean | null | undefined | Date>;
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ */
+export type Update = {
+    type: 'content';
+    data: {
+        source: _Content;
+        metadata: Metadata;
+    };
+} | {
+    type: 'jsx';
+    data: {
+        source: JsxChildren;
+        metadata: Metadata;
+    };
+};
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ */
+export type Request = {
+    type: 'content';
+    data: {
+        source: _Content;
+        targetLocale: string;
+        metadata: Metadata;
+    };
+} | {
+    type: 'jsx';
+    data: {
+        source: JsxChildren;
+        targetLocale: string;
+        metadata: Metadata;
+    };
+};
+/**
+ * @deprecated Use {@link TranslationResult} instead.
+ */
+export type ContentTranslationResult = {
+    translation: _Content;
+    locale: string;
+    reference?: {
+        id: string;
+        key: string;
+    };
+};
+/**
+ * @deprecated Use {@link TranslationResult} instead.
+ */
+export type IcuTranslationResult = {
+    translation: string;
+    locale: string;
+    reference?: {
+        id: string;
+        key: string;
+    };
+};
+/**
+ * @deprecated Use {@link TranslationResult} instead.
+ */
+export type JsxTranslationResult = {
+    translation: JsxChildren;
+    locale: string;
+    reference?: {
+        id: string;
+        key: string;
+    };
+};
+export type { CustomMapping } from './locales/customLocaleMapping';
+/**
+ * TranslationRequestConfig is used to configure the translation request.
+ *
+ * @param projectId - The project ID of the translation request.
+ * @param baseUrl - The base URL of the translation request.
+ * @param apiKey - The API key of the translation request.
+ */
+export type TranslationRequestConfig = {
+    projectId: string;
+    baseUrl?: string;
+    apiKey?: string;
+};

package/dist/types.js

@@ -0,0 +1,2 @@
+import { HTML_CONTENT_PROPS, } from './types-dir/jsx/content';
+export { HTML_CONTENT_PROPS, };

package/dist/utils/base64.d.ts

@@ -0,0 +1,2 @@
+export declare function encode(data: string): string;
+export declare function decode(base64: string): string;

package/dist/utils/base64.js

@@ -0,0 +1,28 @@
+// Encode a string to base64
+export function encode(data) {
+    if (typeof Buffer !== 'undefined') {
+        // Node.js path.
+        return Buffer.from(data, 'utf8').toString('base64');
+    }
+    // Browser path.
+    var bytes = new TextEncoder().encode(data);
+    var binary = '';
+    for (var i = 0; i < bytes.length; i++) {
+        binary += String.fromCharCode(bytes[i]);
+    }
+    return btoa(binary);
+}
+// Decode a base64 string to a string
+export function decode(base64) {
+    if (typeof Buffer !== 'undefined') {
+        // Node.js path.
+        return Buffer.from(base64, 'base64').toString('utf8');
+    }
+    // Browser path.
+    var binary = atob(base64);
+    var bytes = new Uint8Array(binary.length);
+    for (var i = 0; i < binary.length; i++) {
+        bytes[i] = binary.charCodeAt(i);
+    }
+    return new TextDecoder().decode(bytes);
+}

package/dist/utils/isSupportedFileFormatTransform.d.ts

@@ -0,0 +1,8 @@
+import type { FileFormat } from '../types-dir/api/file';
+/**
+ * This function checks if a file format transformation is supported during translation
+ * @param from - The source file format.
+ * @param to - The target file format.
+ * @returns True if the transformation is supported, false otherwise
+ */
+export declare function isSupportedFileFormatTransform(from: FileFormat, to: FileFormat): boolean;