@aws-amplify/core/src/I18n/index.ts

Core category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

import { ConsoleLogger } from '../Logger';

import { I18n as I18nClass } from './I18n';
import { I18nConfig } from './types';
import { I18nErrorCode, assert } from './errorHelpers';

const logger = new ConsoleLogger('I18n');

let _config: I18nConfig = { language: null };
let _i18n: I18nClass | null = null;

/**
 * Export I18n APIs
 */
export class I18n {
	/**
	 * @static
	 * @method
	 * Configure I18n part
	 * @param {Object} config - Configuration of the I18n
	 */
	static configure(config: Record<string, any>) {
		logger.debug('configure I18n');
		if (!config) {
			return _config;
		}

		_config = Object.assign({}, _config, config.I18n || config);

		I18n.createInstance();

		return _config;
	}

	static getModuleName() {
		return 'I18n';
	}

	/**
	 * @static
	 * @method
	 * Create an instance of I18n for the library
	 */
	static createInstance() {
		logger.debug('create I18n instance');
		if (_i18n) {
			return;
		}
		_i18n = new I18nClass();
	}

	/**
	 * @static @method
	 * Explicitly setting language
	 * @param {String} lang
	 */
	static setLanguage(lang: string) {
		I18n.checkConfig();
		assert(!!_i18n, I18nErrorCode.NotConfigured);

		_i18n.setLanguage(lang);
	}

	/**
	 * @static @method
	 * Get value
	 * @param {String} key
	 * @param {String} defVal - Default value
	 */
	static get(key: string, defVal?: string) {
		if (!I18n.checkConfig()) {
			return typeof defVal === 'undefined' ? key : defVal;
		}
		assert(!!_i18n, I18nErrorCode.NotConfigured);

		return _i18n.get(key, defVal);
	}

	/**
	 * @static
	 * @method
	 * Add vocabularies for one language
	 * @param {String} language - Language of the dictionary
	 * @param {Object} vocabularies - Object that has key-value as dictionary entry
	 */
	static putVocabulariesForLanguage(
		language: string,
		vocabularies: Record<string, string>,
	) {
		I18n.checkConfig();
		assert(!!_i18n, I18nErrorCode.NotConfigured);

		_i18n.putVocabulariesForLanguage(language, vocabularies);
	}

	/**
	 * @static
	 * @method
	 * Add vocabularies for one language
	 * @param {Object} vocabularies - Object that has language as key,
	 *                                vocabularies of each language as value
	 */
	static putVocabularies(vocabularies: Record<string, Record<string, string>>) {
		I18n.checkConfig();
		assert(!!_i18n, I18nErrorCode.NotConfigured);

		_i18n.putVocabularies(vocabularies);
	}

	public static checkConfig() {
		if (!_i18n) {
			I18n.createInstance();
		}

		return true;
	}
}

// Create an instance of I18n in the static class
I18n.createInstance();