generaltranslation 8.2.6 → 8.2.7

package/dist/types.d.ts

@@ -1,652 +0,0 @@
-type CustomMapping = Record<string, string | Partial<LocaleProperties>>;
-
-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;
-};
-
-type VariableType = 'v' | 'n' | 'd' | 'c' | 'rt';
-/**
- * Variables are used to store the variable name and type.
- */
-type Variable = {
-    k: string;
-    i?: number;
-    v?: VariableType;
-};
-
-/**
- * Map of data-_gt properties to their corresponding React props
- */
-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";
-};
-type HtmlContentPropKeysRecord = Partial<Record<keyof typeof HTML_CONTENT_PROPS, string>>;
-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'
- */
-type GTProp = {
-    b?: Record<string, JsxChildren>;
-    t?: 'p' | 'b';
-} & HtmlContentPropKeysRecord;
-type JsxElement = {
-    t?: string;
-    i?: number;
-    d?: GTProp;
-    c?: JsxChildren;
-};
-type JsxChild = string | JsxElement | Variable;
-/**
- * The format of the string content
- */
-type StringFormat = 'ICU' | 'I18NEXT' | 'STRING';
-/**
- * The format of the content
- */
-type DataFormat = 'JSX' | StringFormat;
-/**
- * String format content
- */
-type StringContent = IcuMessage | StringMessage | I18nextMessage;
-/**
- * A content type representing JSX, ICU, and I18next messages
- */
-type Content = JsxChildren | StringContent;
-/**
- * A content type representing JSX elements
- */
-type JsxChildren = JsxChild | JsxChild[];
-/**
- * A content type representing ICU messages
- */
-type IcuMessage = string;
-/**
- * A content type representing I18next messages
- */
-type I18nextMessage = string;
-/**
- * A content type representing plain strings
- */
-type StringMessage = string;
-
-/**
- * ActionType is the type of action to perform on the request.
- *
- * @param fast - The fast action type (mini model).
- */
-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.
- */
-type EntryMetadata = {
-    id?: string;
-    hash?: string;
-    context?: string;
-    maxChars?: number;
-    dataFormat?: DataFormat;
-    actionType?: ActionType;
-};
-/**
- * TranslateManyEntry is the input type for translateMany.
- * Can be a plain string or an object with source and entry metadata fields.
- */
-type TranslateManyEntry = string | {
-    source: Content;
-    metadata?: EntryMetadata;
-};
-
-type HashMetadata = {
-    context?: string;
-    id?: string;
-    maxChars?: number;
-    dataFormat?: DataFormat;
-};
-
-type TranslationStatusResult = {
-    count: number;
-    availableLocales: string[];
-    locales: string[];
-    localesWaitingForApproval: any[];
-};
-
-type FileTranslationQuery = {
-    versionId: string;
-    fileName?: string;
-    fileId?: string;
-    locale: string;
-};
-type CheckFileTranslationsOptions = {
-    timeout?: number;
-};
-
-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
- */
-type EnqueueFilesOptions = {
-    requireApproval?: boolean;
-    description?: string;
-    sourceLocale?: string;
-    targetLocales: string[];
-    version?: string;
-    _versionId?: string;
-    timeout?: number;
-    modelProvider?: string;
-    force?: boolean;
-};
-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;
-};
-
-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
- */
-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
- */
-type FileReference = {
-    fileId: string;
-    versionId: string;
-    branchId: string;
-    fileName: string;
-    fileFormat: FileFormat;
-    dataFormat?: DataFormat;
-};
-
-type DownloadFileBatchOptions = {
-    timeout?: number;
-};
-type DownloadedFile = {
-    id: string;
-    branchId: string;
-    fileId: string;
-    versionId: string;
-    locale?: string;
-    fileName?: string;
-    data: string;
-    metadata: Record<string, any>;
-    fileFormat: FileFormat;
-};
-type DownloadFileBatchResult = {
-    files: DownloadedFile[];
-    count: number;
-};
-
-type FetchTranslationsOptions = {
-    timeout?: number;
-};
-type RetrievedTranslation = {
-    locale: string;
-    translation: any;
-};
-type RetrievedTranslations = RetrievedTranslation[];
-type FetchTranslationsResult = {
-    translations: RetrievedTranslations;
-};
-
-type CreateTagFileReference = {
-    fileId: string;
-    versionId: string;
-    branchId: string;
-};
-type CreateTagOptions = {
-    tagId: string;
-    files: CreateTagFileReference[];
-    message?: string;
-};
-type CreateTagResult = {
-    tag: {
-        id: string;
-        tagId: string;
-        message: string | null;
-        createdAt: string;
-        updatedAt: 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';
-    requestVersion?: number;
-    approved_at?: string | null;
-    approved_by?: string | null;
-    hash?: string;
-    staticId?: 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 EnqueueEntriesOptions = {
-    timeout?: number;
-    sourceLocale?: string;
-    targetLocales?: string[];
-    dataFormat?: DataFormat;
-    version?: string;
-    description?: string;
-    requireApproval?: boolean;
-    modelProvider?: string;
-};
-type EnqueueEntriesResult = {
-    versionId: string;
-    locales: string[];
-    message: string;
-    projectSettings: {
-        cdnEnabled: boolean;
-        requireApproval: boolean;
-    };
-};
-
-type PublishFileEntry = {
-    fileId: string;
-    versionId: string;
-    branchId?: string;
-    publish: boolean;
-    fileName?: string;
-};
-type PublishFilesResult = {
-    results: {
-        fileId: string;
-        versionId: string;
-        locale?: string;
-        branchId: string;
-        success: boolean;
-        error?: string;
-    }[];
-};
-
-type DownloadFileOptions = {
-    timeout?: number;
-};
-
-/**
- * TranslationResultReference is used to store the reference for a translation result.
- */
-type TranslationResultReference = {
-    id?: string;
-    hash: string;
-};
-/**
- * TypedResult is a union type that represents the different types of translations that can be returned.
- */
-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.
- */
-type TranslationError = {
-    success: false;
-    error: string;
-    code: number;
-};
-/**
- * RequestSuccess is a type that represents a successful translation request.
- */
-type RequestSuccess = TypedResult & {
-    success: true;
-    locale: string;
-};
-type TranslationResult = RequestSuccess | TranslationError;
-
-/**
- * BatchTranslationResult is the result of a batch translation request.
- */
-type TranslateManyResult = 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 OrphanedFile = {
-    fileId: string;
-    versionId: string;
-    fileName: string;
-};
-type GetOrphanedFilesResult = {
-    orphanedFiles: OrphanedFile[];
-};
-
-type MoveMapping = {
-    oldFileId: string;
-    newFileId: string;
-    newFileName: string;
-};
-type MoveResult = {
-    oldFileId: string;
-    newFileId: string;
-    success: boolean;
-    newSourceFileId?: string;
-    clonedTranslationsCount?: number;
-    error?: string;
-};
-type ProcessMovesResponse = {
-    results: MoveResult[];
-    summary: {
-        total: number;
-        succeeded: number;
-        failed: number;
-    };
-};
-type ProcessMovesOptions = {
-    timeout?: number;
-    branchId?: string;
-};
-
-type JobStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'unknown';
-type CheckJobStatusResult = {
-    jobId: string;
-    status: JobStatus;
-    error?: {
-        message: string;
-    };
-}[];
-
-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;
-};
-type JobResult = {
-    jobId: string;
-    status: JobStatus;
-    error?: {
-        message: string;
-    };
-};
-type AwaitJobsResult = {
-    /** Whether all jobs completed (none still in progress). */
-    complete: boolean;
-    jobs: JobResult[];
-};
-
-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.
- */
-type Transformation = BaseTransformation | `${BaseTransformation}-${InjectionType}`;
-type BaseTransformation = 'translate-client' | 'translate-server' | 'translate-runtime' | 'variable-variable' | 'variable-currency' | 'variable-datetime' | 'variable-number' | 'variable-relative-time' | 'plural' | 'branch' | 'derive';
-type TransformationPrefix = 'translate' | 'variable' | 'plural' | 'branch' | 'fragment' | 'derive';
-type VariableTransformationSuffix = 'variable' | 'number' | 'datetime' | 'currency' | 'relative-time';
-type InjectionType = 'automatic' | 'manual';
-
-/**
- * @deprecated Use {@link Content} instead.
- */
-type _Content = string | Array<string | Variable>;
-
-type Metadata = {
-    maxChars?: number;
-    context?: string;
-    id?: string;
-    sourceLocale?: string;
-    actionType?: 'standard' | 'fast' | string;
-    filePaths?: string[];
-    [key: string]: any;
-};
-type FormatVariables = Record<string, string | number | boolean | null | undefined | Date>;
-/**
- * @deprecated This type is deprecated and will be removed in a future version.
- */
-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.
- */
-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.
- */
-type ContentTranslationResult = {
-    translation: _Content;
-    locale: string;
-    reference?: {
-        id: string;
-        key: string;
-    };
-};
-/**
- * @deprecated Use {@link TranslationResult} instead.
- */
-type IcuTranslationResult = {
-    translation: string;
-    locale: string;
-    reference?: {
-        id: string;
-        key: string;
-    };
-};
-/**
- * @deprecated Use {@link TranslationResult} instead.
- */
-type JsxTranslationResult = {
-    translation: JsxChildren;
-    locale: string;
-    reference?: {
-        id: string;
-        key: string;
-    };
-};
-
-/**
- * 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.
- */
-type TranslationRequestConfig = {
-    projectId: string;
-    baseUrl?: string;
-    apiKey?: string;
-};
-
-export { HTML_CONTENT_PROPS };
-export type { 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, 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 };

package/dist/types.esm.min.mjs

@@ -1,2 +0,0 @@
-var a={pl:"placeholder",ti:"title",alt:"alt",arl:"aria-label",arb:"aria-labelledby",ard:"aria-describedby"};export{a as HTML_CONTENT_PROPS};
-//# sourceMappingURL=types.esm.min.mjs.map

package/dist/types.esm.min.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.esm.min.mjs","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":["HTML_CONTENT_PROPS","pl","ti","alt","arl","arb","ard"],"mappings":"AAKO,IAAMA,EAAqB,CAChCC,GAAI,cACJC,GAAI,QACJC,IAAK,MACLC,IAAK,aACLC,IAAK,kBACLC,IAAK"}

package/dist/utils/base64.d.ts

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

package/dist/utils/isVariable.d.ts

@@ -1,2 +0,0 @@
-import { Variable } from '../types';
-export default function isVariable(obj: unknown): obj is Variable;

package/dist/utils/minify.d.ts

@@ -1,2 +0,0 @@
-import { VariableTransformationSuffix, VariableType } from '../types';
-export declare function minifyVariableType(variableType: VariableTransformationSuffix): VariableType;

package/dist/utils/stableStringify.d.ts

@@ -1 +0,0 @@
-export declare function stableStringify(data: unknown): string;