@google-psat/i18n 0.9.0-1

package/dist/i18n.js

@@ -0,0 +1,216 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * External dependencies.
+ */
+const fs_1 = require("fs");
+const intl_messageformat_1 = require("intl-messageformat");
+const path_1 = __importDefault(require("path"));
+/**
+ * Class representing Internationalization (i18n) functionality.
+ */
+class I18n {
+    constructor() {
+        this.messages = {};
+        this.locale = 'en';
+    }
+    /**
+     * Initializes the messages object with the provided messages.
+     * @param {object} messages - The messages object containing translations.
+     */
+    initMessages(messages = {}) {
+        this.messages = messages;
+    }
+    /**
+     *	Returns the locale string.
+     * @returns {string} The locale string.
+     */
+    getLocale() {
+        var _a;
+        if (typeof chrome !== 'undefined' && ((_a = chrome === null || chrome === void 0 ? void 0 : chrome.i18n) === null || _a === void 0 ? void 0 : _a.getUILanguage)) {
+            return chrome.i18n.getUILanguage();
+        }
+        return this.locale;
+    }
+    /**
+     * Returns the messages object.
+     * @returns {object} The messages object.
+     */
+    getMessages() {
+        return this.messages;
+    }
+    /**
+     * Creates an array of possible locale strings based on the provided locale.
+     * @param {string} locale - The locale string.
+     * @returns {string[]} An array of locale strings.
+     */
+    createLocaleArray(locale) {
+        if (!locale) {
+            return ['en'];
+        }
+        return [
+            locale,
+            locale.replace(/_/g, '-'),
+            locale.replace(/-/g, '_'),
+            locale.split('-')[0],
+            locale.split('_')[0],
+            'en',
+        ];
+    }
+    /**
+     * Asynchronously loads messages data using the provided locale.
+     * @param {string} locale - The locale string.
+     * @returns {Promise<void>} A promise that resolves when messages are loaded.
+     */
+    fetchMessages(locale) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localeArray = this.createLocaleArray(locale);
+            let idx = 0;
+            const fetchWithRetry = () => __awaiter(this, void 0, void 0, function* () {
+                let res = {};
+                if (idx >= localeArray.length) {
+                    return res;
+                }
+                try {
+                    const response = yield fetch(`/_locales/${localeArray[idx]}/messages.json`);
+                    if (!response.ok) {
+                        throw new Error(`Failed to fetch messages for locale ${localeArray[idx]}`);
+                    }
+                    const data = yield response.json();
+                    res = data;
+                    this.locale = localeArray[idx];
+                }
+                catch (error) {
+                    idx++;
+                    res = yield fetchWithRetry();
+                }
+                return res;
+            });
+            const result = yield fetchWithRetry();
+            return result;
+        });
+    }
+    /**
+     * Loads messages data for the CLI.
+     * @param {string} locale - The locale string.
+     */
+    loadCLIMessagesData(locale) {
+        const localeArray = this.createLocaleArray(locale);
+        for (const _locale of localeArray) {
+            let localePath = '';
+            if ((0, fs_1.existsSync)(path_1.default.resolve(__dirname +
+                `../../node_modules/@google-psat/i18n/_locales/messages/${_locale}/messages.json`))) {
+                localePath = path_1.default.resolve(__dirname +
+                    `../../node_modules/@google-psat/i18n/_locales/messages/${_locale}/messages.json`);
+            }
+            else {
+                localePath = path_1.default.resolve(__dirname + `../../../i18n/_locales/messages/${_locale}/messages.json`);
+            }
+            if ((0, fs_1.existsSync)(localePath)) {
+                const messages = JSON.parse((0, fs_1.readFileSync)(localePath, {
+                    encoding: 'utf-8',
+                }));
+                this.initMessages(messages);
+                this.locale = _locale;
+                break;
+            }
+        }
+    }
+    /**
+     * Retrieves a translated message for a given key.
+     * @param {string} key - The key of the message to retrieve.
+     * @param {string[]} [substitutions] - An array of substitution values for placeholders in the message.
+     * @param {boolean} [escapeLt] - Whether to escape '<' characters.
+     * @returns {string} The translated message.
+     */
+    getMessage(key, substitutions, escapeLt) {
+        var _a;
+        if (typeof chrome !== 'undefined' && ((_a = chrome === null || chrome === void 0 ? void 0 : chrome.i18n) === null || _a === void 0 ? void 0 : _a.getMessage)) {
+            try {
+                // @ts-ignore - Outdated definition.
+                const text = chrome.i18n.getMessage(key, substitutions, {
+                    escapeLt: Boolean(escapeLt),
+                });
+                return text;
+            }
+            catch (error) {
+                console.log(error);
+            }
+        }
+        return this._parseMessage(key, substitutions, escapeLt);
+    }
+    /**
+     * Parses a message with substitutions and placeholders.
+     * @param {string} key - The key of the message to parse.
+     * @param {string[]} [substitutions] - An array of substitution values for placeholders in the message.
+     * @param {boolean} [escapeLt] - Whether to escape '<' characters.
+     * @returns {string} The parsed message.
+     */
+    _parseMessage(key, substitutions, escapeLt) {
+        var _a;
+        const messageObj = (_a = this.messages) === null || _a === void 0 ? void 0 : _a[key];
+        if (!messageObj) {
+            return '';
+        }
+        const message = messageObj.message
+            .split('$')
+            .map((part, idx) => (idx % 2 ? `{${part}}` : part))
+            .join('');
+        const placeholders = Object.entries(messageObj.placeholders || {}).reduce((acc, [placeholderKey, val]) => {
+            const idx = Number(val.content.substring(1)) - 1;
+            acc[placeholderKey] = (substitutions === null || substitutions === void 0 ? void 0 : substitutions[idx]) || '';
+            return acc;
+        }, {});
+        return new intl_messageformat_1.IntlMessageFormat(message, 'en', undefined, {
+            ignoreTag: escapeLt,
+        }).format(placeholders);
+    }
+    /**
+     * Returns messages wrapped with HTML tags.
+     * Prefix keys with 'header_{key}', 'body_{count}_{key}' to wrap with appropriate tags.
+     * @param keys - The keys of the messages to retrieve.
+     * @returns {string} The formatted messages.
+     */
+    getFormattedMessages(keys) {
+        return keys === null || keys === void 0 ? void 0 : keys.map((key) => {
+            const [type] = key.split('_');
+            const message = this.getMessage(key);
+            switch (type) {
+                case 'header':
+                    return `<h1 className='font-semibold'>${message}</h1>`;
+                case 'body':
+                    return `<p>${message}</p>`;
+                default:
+                    return message;
+            }
+        }).join('');
+    }
+}
+exports.default = new I18n();

package/dist/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.I18n = void 0;
+var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "I18n", { enumerable: true, get: function () { return __importDefault(i18n_1).default; } });

package/dist-types/i18n.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Class representing Internationalization (i18n) functionality.
+ */
+declare class I18n {
+    private messages;
+    private locale;
+    /**
+     * Initializes the messages object with the provided messages.
+     * @param {object} messages - The messages object containing translations.
+     */
+    initMessages(messages?: {}): void;
+    /**
+     *	Returns the locale string.
+     * @returns {string} The locale string.
+     */
+    getLocale(): string;
+    /**
+     * Returns the messages object.
+     * @returns {object} The messages object.
+     */
+    getMessages(): {
+        [key: string]: {
+            message: string;
+            description: string;
+            placeholders: {
+                [key: string]: {
+                    content: string;
+                    example: string;
+                };
+            };
+        };
+    };
+    /**
+     * Creates an array of possible locale strings based on the provided locale.
+     * @param {string} locale - The locale string.
+     * @returns {string[]} An array of locale strings.
+     */
+    private createLocaleArray;
+    /**
+     * Asynchronously loads messages data using the provided locale.
+     * @param {string} locale - The locale string.
+     * @returns {Promise<void>} A promise that resolves when messages are loaded.
+     */
+    fetchMessages(locale: string): Promise<{}>;
+    /**
+     * Loads messages data for the CLI.
+     * @param {string} locale - The locale string.
+     */
+    loadCLIMessagesData(locale: string): void;
+    /**
+     * Retrieves a translated message for a given key.
+     * @param {string} key - The key of the message to retrieve.
+     * @param {string[]} [substitutions] - An array of substitution values for placeholders in the message.
+     * @param {boolean} [escapeLt] - Whether to escape '<' characters.
+     * @returns {string} The translated message.
+     */
+    getMessage(key: string, substitutions?: string[], escapeLt?: boolean): string;
+    /**
+     * Parses a message with substitutions and placeholders.
+     * @param {string} key - The key of the message to parse.
+     * @param {string[]} [substitutions] - An array of substitution values for placeholders in the message.
+     * @param {boolean} [escapeLt] - Whether to escape '<' characters.
+     * @returns {string} The parsed message.
+     */
+    private _parseMessage;
+    /**
+     * Returns messages wrapped with HTML tags.
+     * Prefix keys with 'header_{key}', 'body_{count}_{key}' to wrap with appropriate tags.
+     * @param keys - The keys of the messages to retrieve.
+     * @returns {string} The formatted messages.
+     */
+    getFormattedMessages(keys: string[]): string;
+}
+declare const _default: I18n;
+export default _default;

package/dist-types/index.d.ts

@@ -0,0 +1 @@
+export { default as I18n } from './i18n';

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@google-psat/i18n",
+  "version": "0.9.0-1",
+  "description": "A package that handles internationalization and localization.",
+  "main": "dist/index.js",
+  "types": "dist-types/index.d.ts",
+  "source": "src/index.ts",
+  "customExports": {
+    ".": {
+      "default": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "dev": "tsc-watch --build",
+    "build:remove": "rimraf dist dist-types tsconfig.tsbuildinfo",
+    "publish:local": "npm publish --registry=http://localhost:4873",
+    "publish:remote": "npm publish --access=public --registry=https://registry.npmjs.org",
+    "unpublish:local": "npm unpublish --registry=http://localhost:4873 --force",
+    "unpublish:remote": "npm unpublish --registry=https://registry.npmjs.org --force"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GoogleChromeLabs/ps-analysis-tool",
+    "directory": "packages/i18n"
+  },
+  "author": {
+    "name": "Google"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/GoogleChromeLabs/ps-analysis-tool/issues"
+  },
+  "homepage": "https://github.com/GoogleChromeLabs/ps-analysis-tool",
+  "dependencies": {
+    "intl-messageformat": "^10.5.11"
+  }
+}

package/scripts/merge-messages.cjs

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * External dependencies.
+ */
+const fs = require('fs');
+
+const PACKAGES = [
+  'cli',
+  'cli-dashboard',
+  'common',
+  'design-system',
+  'extension',
+  'library-detection',
+];
+const COMMON_PATH = 'packages/i18n/_locales';
+const TARGET = `${COMMON_PATH}/messages/en/messages.json`;
+
+const main = () => {
+  const messages = {};
+
+  PACKAGES.forEach((pkg) => {
+    const path = `${COMMON_PATH}/packages/${pkg}/messages.json`;
+    const data = fs.readFileSync(path, 'utf8') || '{}';
+    const parsed = JSON.parse(data);
+
+    Object.entries(parsed).forEach(([key, value]) => {
+      if (messages[key]) {
+        throw new Error(
+          `Duplicate key: ${key}, found in ${pkg}. Please resolve this conflict before continuing.`
+        );
+      }
+
+      messages[key] = value;
+    });
+
+    console.log(`Merged ${pkg} messages`);
+
+    fs.unlinkSync(path);
+    fs.writeFileSync(path, '{}');
+
+    console.log(`Deleted ${pkg} messages`);
+  });
+
+  fs.writeFileSync(TARGET, JSON.stringify(messages, null, 2));
+};
+
+main();

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "jsx": "preserve",
+    "rootDir": "src",
+    "target": "es6",
+    "lib": ["es2021"],
+    "module": "commonjs",
+    "outDir": "dist",
+    "declarationDir": "dist-types",
+    "composite": true,
+    "strict": true,
+    "sourceMap": false,
+    "esModuleInterop": true,
+    "moduleResolution": "node"
+  },
+  "exclude": ["**/tests/**/*.ts", "dist/**", "dist-types/**"]
+}