@logto/cli 1.0.3 → 1.1.0

package/lib/commands/connector/remove.js

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 import chalk from 'chalk';
 import { log } from '../../utils.js';
 import { getConnectorPackagesFrom } from './utils.js';

package/lib/commands/connector/utils.js

@@ -1,9 +1,9 @@
-import { exec } from 'child_process';
-import { existsSync } from 'fs';
-import fs from 'fs/promises';
-import path from 'path';
-import { promisify } from 'util';
-import { assert, conditionalString, trySafe } from '@silverhand/essentials';
+import { exec } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { promisify } from 'node:util';
+import { assert, conditionalArray, conditionalString, trySafe } from '@silverhand/essentials';
 import chalk from 'chalk';
 import { got } from 'got';
 import inquirer from 'inquirer';
@@ -142,7 +142,7 @@ const fetchOfficialConnectorList = async (includingCloudConnectors = false) => {
     for (let page = 0;; ++page) {
         // eslint-disable-next-line no-await-in-loop
         const { objects } = await fetchList(page * 20, 20);
-        const excludeList = ['mock', 'kit', ...(includingCloudConnectors ? [] : ['logto'])];
+        const excludeList = ['mock', 'kit', ...conditionalArray(!includingCloudConnectors && 'logto')];
         // eslint-disable-next-line @silverhand/fp/no-mutating-methods
         packages.push(...objects
             .filter(({ package: { name, scope } }) => scope === 'logto' &&

package/lib/commands/database/alteration/utils.js

@@ -1,7 +1,7 @@
-import { existsSync } from 'fs';
-import fs from 'fs/promises';
+import { existsSync } from 'node:fs';
+import fs from 'node:fs/promises';
+import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import path from 'path';
 import { findPackage } from '@logto/shared';
 import { getPathInModule } from '../../../utils.js';
 const currentDirname = path.dirname(fileURLToPath(import.meta.url));

package/lib/commands/database/seed/oidc-config.js

@@ -1,4 +1,4 @@
-import { readFile } from 'fs/promises';
+import { readFile } from 'node:fs/promises';
 import { LogtoOidcConfigKey, logtoConfigGuards } from '@logto/schemas';
 import { getEnvAsStringArray } from '@silverhand/essentials';
 import chalk from 'chalk';

package/lib/commands/database/seed/tables.js

@@ -1,5 +1,5 @@
-import { readdir, readFile } from 'fs/promises';
-import path from 'path';
+import { readdir, readFile } from 'node:fs/promises';
+import path from 'node:path';
 import { createDefaultAdminConsoleConfig, defaultTenantId, adminTenantId, defaultManagementApi, createAdminDataInAdminTenant, createMeApiInAdminTenant, createDefaultSignInExperience, createAdminTenantSignInExperience, createDefaultAdminConsoleApplication, createCloudApi, createTenantApplicationRole, createTenantMachineToMachineApplication, createAdminTenantApplicationRole, CloudScope, } from '@logto/schemas';
 import { Tenants } from '@logto/schemas/models';
 import { sql } from 'slonik';

package/lib/commands/database/utils.js

@@ -1,5 +1,5 @@
-import { generateKeyPair } from 'crypto';
-import { promisify } from 'util';
+import { generateKeyPair } from 'node:crypto';
+import { promisify } from 'node:util';
 import { generateStandardId } from '@logto/core-kit';
 export const generateOidcPrivateKey = async (type = 'ec') => {
     if (type === 'rsa') {

package/lib/commands/install/utils.js

@@ -1,8 +1,8 @@
-import { execSync } from 'child_process';
-import { existsSync } from 'fs';
-import fs from 'fs/promises';
-import os from 'os';
-import path from 'path';
+import { execSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
 import { assert } from '@silverhand/essentials';
 import chalk from 'chalk';
 import inquirer from 'inquirer';

package/lib/commands/translate/create.d.ts

@@ -0,0 +1,8 @@
+import type { CommandModule } from 'yargs';
+declare const create: CommandModule<{
+    path?: string;
+}, {
+    path?: string;
+    'language-tag': string;
+}>;
+export default create;

package/lib/commands/translate/create.js

@@ -0,0 +1,75 @@
+import { existsSync } from 'node:fs';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { isLanguageTag } from '@logto/language-kit';
+import { isBuiltInLanguageTag as isPhrasesBuiltInLanguageTag } from '@logto/phrases';
+import { isBuiltInLanguageTag as isPhrasesUiBuiltInLanguageTag } from '@logto/phrases-ui';
+import { conditionalString } from '@silverhand/essentials';
+import { log } from '../../utils.js';
+import { inquireInstancePath } from '../connector/utils.js';
+import { createOpenaiApi, translate } from './openai.js';
+import { baseLanguage, readBaseLocaleFiles } from './utils.js';
+const createFullTranslation = async (instancePath, packageName, languageTag) => {
+    const directory = path.join(await inquireInstancePath(instancePath), 'packages', packageName, 'src/locales');
+    const files = await readBaseLocaleFiles(directory);
+    log.info('Found ' +
+        String(files.length) +
+        ' file' +
+        conditionalString(files.length !== 1 && 's') +
+        ' in ' +
+        packageName +
+        ' to translate');
+    const openai = createOpenaiApi();
+    /* eslint-disable no-await-in-loop */
+    for (const file of files) {
+        const relativePath = path.relative(path.join(directory, baseLanguage.toLowerCase()), file);
+        const targetPath = path.join(directory, languageTag.toLowerCase(), relativePath);
+        const getTranslationPath = async () => {
+            if (existsSync(targetPath)) {
+                const currentContent = await fs.readFile(targetPath, 'utf8');
+                if (currentContent.includes('// UNTRANSLATED')) {
+                    return targetPath;
+                }
+                log.info(`Target path ${targetPath} exists and has no untranslated mark, skipping`);
+                return;
+            }
+            return file;
+        };
+        const translationPath = await getTranslationPath();
+        if (!translationPath) {
+            continue;
+        }
+        log.info(`Translating ${translationPath}`);
+        const result = await translate(openai, languageTag, translationPath);
+        if (!result) {
+            log.error(`Unable to translate ${translationPath}`);
+        }
+        await fs.mkdir(path.parse(targetPath).dir, { recursive: true });
+        await fs.writeFile(targetPath, result);
+        log.succeed(`Translated ${targetPath}`);
+    }
+    /* eslint-enable no-await-in-loop */
+};
+const create = {
+    command: ['create <language-tag>', 'c'],
+    describe: 'Create a new language translation',
+    builder: (yargs) => yargs.positional('language-tag', {
+        describe: 'The language tag to create, e.g. `af-ZA`.',
+        type: 'string',
+        demandOption: true,
+    }),
+    handler: async ({ path: inputPath, languageTag }) => {
+        if (!isLanguageTag(languageTag)) {
+            log.error('Invalid language tag. Run `logto translate list-tags` to see available list.');
+        }
+        if (isPhrasesBuiltInLanguageTag(languageTag)) {
+            log.info(languageTag + ' is a built-in tag of phrases, updating untranslated phrases');
+        }
+        await createFullTranslation(inputPath, 'phrases', languageTag);
+        if (isPhrasesUiBuiltInLanguageTag(languageTag)) {
+            log.info(languageTag + ' is a built-in tag of phrases-ui, updating untranslated phrases');
+        }
+        await createFullTranslation(inputPath, 'phrases-ui', languageTag);
+    },
+};
+export default create;

package/lib/commands/translate/index.d.ts

@@ -0,0 +1,3 @@
+import type { CommandModule } from 'yargs';
+declare const translate: CommandModule;
+export default translate;

package/lib/commands/translate/index.js

@@ -0,0 +1,18 @@
+import { noop } from '@silverhand/essentials';
+import create from './create.js';
+import listTags from './list-tags.js';
+const translate = {
+    command: ['translate', 't'],
+    describe: 'Commands for Logto translation',
+    builder: (yargs) => yargs
+        .option('path', {
+        alias: 'p',
+        type: 'string',
+        describe: 'The path to your Logto instance directory',
+    })
+        .command(create)
+        .command(listTags)
+        .demandCommand(1),
+    handler: noop,
+};
+export default translate;

package/lib/commands/translate/list-tags.d.ts

@@ -0,0 +1,3 @@
+import type { CommandModule } from 'yargs';
+declare const listTags: CommandModule<Record<string, unknown>>;
+export default listTags;

package/lib/commands/translate/list-tags.js

@@ -0,0 +1,18 @@
+import { languages } from '@logto/language-kit';
+import { isBuiltInLanguageTag as isPhrasesBuiltInLanguageTag } from '@logto/phrases';
+import { isBuiltInLanguageTag as isPhrasesUiBuiltInLanguageTag } from '@logto/phrases-ui';
+import chalk from 'chalk';
+const listTags = {
+    command: ['list-tags', 'list'],
+    describe: 'List all available language tags',
+    handler: async () => {
+        for (const tag of Object.keys(languages)) {
+            console.log(...[
+                tag,
+                isPhrasesBuiltInLanguageTag(tag) && chalk.blue('phrases'),
+                isPhrasesUiBuiltInLanguageTag(tag) && chalk.blue('phrases-ui'),
+            ].filter(Boolean));
+        }
+    },
+};
+export default listTags;

package/lib/commands/translate/openai.d.ts

@@ -0,0 +1,4 @@
+import { type LanguageTag } from '@logto/language-kit';
+import { type Got } from 'got';
+export declare const createOpenaiApi: () => Got;
+export declare const translate: (api: Got, languageTag: LanguageTag, filePath: string) => Promise<string | undefined>;

package/lib/commands/translate/openai.js

@@ -0,0 +1,73 @@
+import fs from 'node:fs/promises';
+import { languages } from '@logto/language-kit';
+import { trySafe } from '@silverhand/essentials';
+import { got, HTTPError } from 'got';
+import { HttpsProxyAgent } from 'hpagent';
+import { z } from 'zod';
+import { getProxy, log } from '../../utils.js';
+export const createOpenaiApi = () => {
+    const proxy = getProxy();
+    return got.extend({
+        prefixUrl: 'https://api.openai.com/v1',
+        headers: {
+            Authorization: `Bearer ${process.env.OPENAI_API_KEY ?? ''}`,
+        },
+        timeout: { request: 300_000 },
+        ...(proxy && { agent: { https: new HttpsProxyAgent({ proxy, timeout: 300_000 }) } }),
+    });
+};
+const gptResponseGuard = z.object({
+    choices: z
+        .object({
+        message: z.object({ role: z.string(), content: z.string() }),
+        finish_reason: z.string(),
+    })
+        .array(),
+});
+export const translate = async (api, languageTag, filePath) => {
+    const fileContent = await fs.readFile(filePath, 'utf8');
+    const response = await trySafe(api
+        .post('chat/completions', {
+        json: {
+            model: 'gpt-3.5-turbo',
+            messages: [
+                {
+                    role: 'user',
+                    content: `Given the following code snippet, only translate object values to ${languages[languageTag]}, keep all object keys original, output ts code only: \n \`\`\`ts\n${fileContent}\n\`\`\``,
+                },
+            ],
+        },
+    })
+        .json(), (error) => {
+        log.warn(`Error while translating ${filePath}:`, String(error));
+        if (error instanceof HTTPError) {
+            log.warn(error.response.body);
+        }
+    });
+    if (!response) {
+        return;
+    }
+    const guarded = gptResponseGuard.safeParse(response);
+    if (!guarded.success) {
+        log.warn(`Error while guarding response for ${filePath}:`, response);
+        return;
+    }
+    const [entity] = guarded.data.choices;
+    if (!entity) {
+        log.warn(`No choice found in response when translating ${filePath}`);
+        return;
+    }
+    if (entity.finish_reason !== 'stop') {
+        log.warn(`Unexpected finish reason ${entity.finish_reason} for ${filePath}`);
+    }
+    const { content } = entity.message;
+    const matched = /```(?:ts)?\n(.*)```/s.exec(content)?.[1];
+    if (!matched) {
+        // Treat as pure code
+        if (['const ', 'import '].some((prefix) => content.startsWith(prefix))) {
+            return content;
+        }
+        log.warn('No matching code snippet from response:', content);
+    }
+    return matched;
+};

package/lib/commands/translate/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const baseLanguage = "en";
+export declare const readLocaleFiles: (directory: string) => Promise<string[]>;
+export declare const readBaseLocaleFiles: (directory: string) => Promise<string[]>;

package/lib/commands/translate/utils.js

@@ -0,0 +1,22 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { log } from '../../utils.js';
+export const baseLanguage = 'en';
+export const readLocaleFiles = async (directory) => {
+    const entities = await fs.readdir(directory, { withFileTypes: true });
+    const result = await Promise.all(entities.map(async (entity) => {
+        if (entity.isDirectory()) {
+            return readLocaleFiles(path.join(directory, entity.name));
+        }
+        return entity.name.endsWith('.ts') ? path.join(directory, entity.name) : [];
+    }));
+    return result.flat();
+};
+export const readBaseLocaleFiles = async (directory) => {
+    const enDirectory = path.join(directory, baseLanguage.toLowerCase());
+    const stat = await fs.stat(enDirectory);
+    if (!stat.isDirectory()) {
+        log.error(directory, 'has no `' + baseLanguage.toLowerCase() + '` directory');
+    }
+    return readLocaleFiles(enDirectory);
+};

package/lib/connector/loader.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import connectorKitMeta from '@logto/connector-kit/package.json' assert { type: 'json' };
 import { satisfies } from 'semver';
 import { isKeyInObject } from './utils.js';

package/lib/connector/utils.js

@@ -1,6 +1,6 @@
-import { existsSync } from 'fs';
-import { readFile } from 'fs/promises';
-import path from 'path';
+import { existsSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import path from 'node:path';
 import { ConnectorError, ConnectorErrorCodes, ConnectorType } from '@logto/connector-kit';
 import { notImplemented } from './consts.js';
 export function validateConnectorModule(connector) {

package/lib/index.js

@@ -5,6 +5,7 @@ import { hideBin } from 'yargs/helpers';
 import connector from './commands/connector/index.js';
 import database from './commands/database/index.js';
 import install from './commands/install/index.js';
+import translate from './commands/translate/index.js';
 import { packageJson } from './package-json.js';
 import { cliConfig, ConfigKey } from './utils.js';
 void yargs(hideBin(process.argv))
@@ -42,6 +43,7 @@ void yargs(hideBin(process.argv))
     .command(install)
     .command(database)
     .command(connector)
+    .command(translate)
     .demandCommand(1)
     .showHelpOnFail(false, `Specify ${chalk.green('--help')} for available options`)
     .strict()

package/lib/package-json.d.ts

@@ -42,6 +42,9 @@ export declare const packageJson: {
     dependencies: {
         "@logto/connector-kit": string;
         "@logto/core-kit": string;
+        "@logto/language-kit": string;
+        "@logto/phrases": string;
+        "@logto/phrases-ui": string;
         "@logto/schemas": string;
         "@logto/shared": string;
         "@silverhand/essentials": string;

package/lib/package-json.js

@@ -1,6 +1,6 @@
 export const packageJson = {
     "name": "@logto/cli",
-    "version": "1.0.3",
+    "version": "1.1.0",
     "description": "Logto CLI.",
     "author": "Silverhand Inc. <contact@silverhand.io>",
     "homepage": "https://github.com/logto-io/logto#readme",
@@ -45,6 +45,9 @@ export const packageJson = {
     "dependencies": {
         "@logto/connector-kit": "workspace:^",
         "@logto/core-kit": "workspace:^",
+        "@logto/language-kit": "workspace:^",
+        "@logto/phrases": "workspace:^",
+        "@logto/phrases-ui": "workspace:^",
         "@logto/schemas": "workspace:^",
         "@logto/shared": "workspace:^",
         "@silverhand/essentials": "^2.5.0",
@@ -69,8 +72,8 @@ export const packageJson = {
         "zod": "^3.20.2"
     },
     "devDependencies": {
-        "@silverhand/eslint-config": "2.0.1",
-        "@silverhand/ts-config": "2.0.3",
+        "@silverhand/eslint-config": "3.0.0",
+        "@silverhand/ts-config": "3.0.0",
         "@types/inquirer": "^9.0.0",
         "@types/jest": "^29.4.0",
         "@types/node": "^18.11.18",

package/lib/utils.d.ts

@@ -8,6 +8,7 @@ type Log = Readonly<{
     error: (...args: Parameters<typeof console.log>) => never;
 }>;
 export declare const log: Log;
+export declare const getProxy: () => string | undefined;
 export declare const downloadFile: (url: string, destination: string) => Promise<unknown>;
 export declare const getPathInModule: (moduleName: string, relativePath?: string) => string;
 export declare const oraPromise: <T>(promise: PromiseLike<T>, options?: Options, exitOnError?: boolean) => Promise<T>;

package/lib/utils.js

@@ -1,8 +1,8 @@
-import { execSync } from 'child_process';
-import { createWriteStream, existsSync } from 'fs';
-import { readdir, readFile } from 'fs/promises';
-import { createRequire } from 'module';
-import path from 'path';
+import { execSync } from 'node:child_process';
+import { createWriteStream, existsSync } from 'node:fs';
+import { readdir, readFile } from 'node:fs/promises';
+import { createRequire } from 'node:module';
+import path from 'node:path';
 import { conditionalString } from '@silverhand/essentials';
 import chalk from 'chalk';
 import { got } from 'got';
@@ -32,10 +32,13 @@ export const log = Object.freeze({
         process.exit(1);
     },
 });
-export const downloadFile = async (url, destination) => {
+export const getProxy = () => {
     const { HTTPS_PROXY, HTTP_PROXY, https_proxy, http_proxy } = process.env;
+    return HTTPS_PROXY ?? https_proxy ?? HTTP_PROXY ?? http_proxy;
+};
+export const downloadFile = async (url, destination) => {
     const file = createWriteStream(destination);
-    const proxy = HTTPS_PROXY ?? https_proxy ?? HTTP_PROXY ?? http_proxy;
+    const proxy = getProxy();
     const stream = got.stream(url, {
         ...(proxy && { agent: { https: new HttpsProxyAgent({ proxy }) } }),
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/cli",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Logto CLI.",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "homepage": "https://github.com/logto-io/logto#readme",
@@ -48,14 +48,17 @@
     "tar": "^6.1.11",
     "yargs": "^17.6.0",
     "zod": "^3.20.2",
+    "@logto/connector-kit": "^1.1.0",
     "@logto/core-kit": "^1.1.0",
-    "@logto/schemas": "^1.0.7",
-    "@logto/shared": "^1.0.2",
-    "@logto/connector-kit": "^1.1.0"
+    "@logto/language-kit": "^1.0.0",
+    "@logto/phrases": "^1.1.0",
+    "@logto/phrases-ui": "^1.1.0",
+    "@logto/schemas": "^1.1.0",
+    "@logto/shared": "^1.0.3"
   },
   "devDependencies": {
-    "@silverhand/eslint-config": "2.0.1",
-    "@silverhand/ts-config": "2.0.3",
+    "@silverhand/eslint-config": "3.0.0",
+    "@silverhand/ts-config": "3.0.0",
     "@types/inquirer": "^9.0.0",
     "@types/jest": "^29.4.0",
     "@types/node": "^18.11.18",