@lokalise/node-api/src/types/files.ts

Official Lokalise API 2.0 Node.js client

import type { ProjectWithPagination } from "./common_get_params.js";
import type { FileFormat } from "./file_format.js";

export type DownloadBundle = {
	project_id: string;
	bundle_url: string;
	branch?: string;
	responseTooBig?: boolean;
};

export type FileDeleted = {
	project_id: string;
	file_deleted: boolean;
};

type LanguageMapping = {
	original_language_iso: string;
	custom_language_iso: string;
};

type FilterData =
	| "translated"
	| "untranslated"
	| "reviewed"
	| "reviewed_only"
	| "last_reviewed_only"
	| "verified"
	| "nonhidden";

type ExportSort = "first_added" | "last_added" | "last_updated" | "a_z" | "z_a";

type ExportEmptyAs = "empty" | "base" | "null" | "skip";

type ExportNullAs = "null" | "empty";

type Trigger =
	| "amazons3"
	| "gcs"
	| "github"
	| "github-enterprise"
	| "gitlab"
	| "bitbucket"
	| "bitbucket-enterprise"
	| "azure";

type PluralFormat =
	| "json_string"
	| "icu"
	| "array"
	| "generic"
	| "symfony"
	| "i18next"
	| "i18next_v4";

type PlaceholderFormat =
	| "printf"
	| "ios"
	| "icu"
	| "net"
	| "symfony"
	| "i18n"
	| "raw";

type Indentation =
	| "default"
	| "1sp"
	| "2sp"
	| "3sp"
	| "4sp"
	| "5sp"
	| "6sp"
	| "7sp"
	| "8sp"
	| "tab";

type JavaPropertiesEncoding = "utf-8" | "latin-1";

export interface DownloadFileParams {
	format: FileFormat;
	original_filenames?: boolean;
	bundle_structure?: string;
	directory_prefix?: string;
	all_platforms?: boolean;
	filter_langs?: string[];
	filter_data?: FilterData[];
	filter_filenames?: string[];
	add_newline_eof?: boolean;
	custom_translation_status_ids?: string[] | number[];
	include_tags?: string[];
	exclude_tags?: string[];
	export_sort?: ExportSort;
	export_empty_as?: ExportEmptyAs;
	export_null_as?: ExportNullAs;
	include_comments?: boolean;
	include_description?: boolean;
	include_pids?: string[];
	triggers?: Trigger[];
	filter_repositories?: string[];
	replace_breaks?: boolean;
	disable_references?: boolean;
	plural_format?: PluralFormat;
	placeholder_format?: PlaceholderFormat;
	webhook_url?: string;
	language_mapping?: LanguageMapping[];
	icu_numeric?: boolean;
	escape_percent?: boolean;
	indentation?: Indentation;
	yaml_include_root?: boolean;
	json_unescaped_slashes?: boolean;
	java_properties_encoding?: JavaPropertiesEncoding;
	java_properties_separator?: "=" | ":";
	bundle_description?: string;
	filter_task_id?: number;
	compact?: boolean;
}

export interface UploadFileParams {
	data: string;
	filename: string;
	lang_iso: string;
	convert_placeholders?: boolean;
	detect_icu_plurals?: boolean;
	tags?: string[];
	tag_inserted_keys?: boolean;
	tag_updated_keys?: boolean;
	tag_skipped_keys?: boolean;
	replace_modified?: boolean;
	slashn_to_linebreak?: boolean;
	keys_to_values?: boolean;
	distinguish_by_file?: boolean;
	apply_tm?: boolean;
	use_automations?: boolean;
	hidden_from_contributors?: boolean;
	cleanup_mode?: boolean;
	custom_translation_status_ids?: string[] | number[];
	custom_translation_status_inserted_keys?: boolean;
	custom_translation_status_updated_keys?: boolean;
	custom_translation_status_skipped_keys?: boolean;
	skip_detect_lang_iso?: boolean;
	format?: FileFormat;
	filter_task_id?: number;
}

export type ListFileParams = ProjectWithPagination & {
	filter_filename?: string;
};