generaltranslation 8.2.5 → 8.2.7

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

@@ -1,21 +0,0 @@
-import { DataFormat } from '../jsx/content';
-export type { Updates } from './enqueueFiles';
-export type EnqueueEntriesOptions = {
-    timeout?: number;
-    sourceLocale?: string;
-    targetLocales?: string[];
-    dataFormat?: DataFormat;
-    version?: string;
-    description?: string;
-    requireApproval?: boolean;
-    modelProvider?: string;
-};
-export type EnqueueEntriesResult = {
-    versionId: string;
-    locales: string[];
-    message: string;
-    projectSettings: {
-        cdnEnabled: boolean;
-        requireApproval: boolean;
-    };
-};

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

@@ -1,56 +0,0 @@
-import { JsxChildren } from '../jsx/content';
-export type Updates = ({
-    metadata: Record<string, any> & {
-        staticId?: string;
-    };
-} & ({
-    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;
-};

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

@@ -1,36 +0,0 @@
-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 TranslateOptions = {
-    targetLocale: string;
-    sourceLocale?: string;
-    modelProvider?: 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/fetchTranslations.d.ts

@@ -1,11 +0,0 @@
-export type FetchTranslationsOptions = {
-    timeout?: number;
-};
-export type RetrievedTranslation = {
-    locale: string;
-    translation: any;
-};
-export type RetrievedTranslations = RetrievedTranslation[];
-export type FetchTranslationsResult = {
-    translations: RetrievedTranslations;
-};

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

@@ -1,54 +0,0 @@
-import { DataFormat } from '../jsx/content';
-import { Updates } from './enqueueFiles';
-export type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT' | 'TWILIO_CONTENT_JSON';
-/**
- * Metadata for files or entries
- */
-type FormatMetadata = Record<string, any> | 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;
-    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;
-    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;
-    dataFormat?: DataFormat;
-};
-export {};

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

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

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

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

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

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

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

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

@@ -1,43 +0,0 @@
-import { DataFormat } from '../jsx/content';
-import { FileFormat, FileReference } 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;
-    dataFormat?: DataFormat;
-    locale: string;
-    formatMetadata?: GTJsonFormatMetadata;
-    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/jsx/content.d.ts

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

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

@@ -1,8 +0,0 @@
-/**
- * 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.cjs.min.cjs

@@ -1,2 +0,0 @@
-"use strict";exports.HTML_CONTENT_PROPS={pl:"placeholder",ti:"title",alt:"alt",arl:"aria-label",arb:"aria-labelledby",ard:"aria-describedby"};
-//# sourceMappingURL=types.cjs.min.cjs.map

package/dist/types.cjs.min.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.cjs.min.cjs","sources":["../src/types-dir/jsx/content.ts"],"sourcesContent":["import { Variable } from './variables';\n\n/**\n * Map of data-_gt properties to their corresponding React props\n */\nexport const HTML_CONTENT_PROPS = {\n  pl: 'placeholder',\n  ti: 'title',\n  alt: 'alt',\n  arl: 'aria-label',\n  arb: 'aria-labelledby',\n  ard: 'aria-describedby',\n} as const;\n\nexport type HtmlContentPropKeysRecord = Partial<\n  Record<keyof typeof HTML_CONTENT_PROPS, string>\n>;\nexport type HtmlContentPropValuesRecord = Partial<\n  Record<(typeof HTML_CONTENT_PROPS)[keyof typeof HTML_CONTENT_PROPS], string>\n>;\n\n/**\n * GTProp is an internal property used to contain data for translating and rendering elements.\n * note, transformations are only read on the server side if they are 'plural' or 'branch'\n */\nexport type GTProp = {\n  b?: Record<string, JsxChildren>; // Branches\n  t?: 'p' | 'b'; // Branch Transformation\n} & HtmlContentPropKeysRecord;\n\nexport type JsxElement = {\n  t?: string; // tag name\n  i?: number; // id\n  d?: GTProp; // GT data\n  c?: JsxChildren; // children\n};\n\nexport type JsxChild = string | JsxElement | Variable;\n\n/**\n * The format of the string content\n */\nexport type StringFormat = 'ICU' | 'I18NEXT' | 'STRING';\n\n/**\n * The format of the content\n */\nexport type DataFormat = 'JSX' | StringFormat;\n\n/**\n * String format content\n */\nexport type StringContent = IcuMessage | StringMessage | I18nextMessage;\n\n/**\n * A content type representing JSX, ICU, and I18next messages\n */\nexport type Content = JsxChildren | StringContent;\n\n/**\n * A content type representing JSX elements\n */\nexport type JsxChildren = JsxChild | JsxChild[];\n\n/**\n * A content type representing ICU messages\n */\nexport type IcuMessage = string;\n\n/**\n * A content type representing I18next messages\n */\nexport type I18nextMessage = string;\n\n/**\n * A content type representing plain strings\n */\nexport type StringMessage = string;\n"],"names":["pl","ti","alt","arl","arb","ard"],"mappings":"wCAKkC,CAChCA,GAAI,cACJC,GAAI,QACJC,IAAK,MACLC,IAAK,aACLC,IAAK,kBACLC,IAAK"}