@logto/cli 1.7.0 → 1.9.0

package/lib/commands/connector/add.js

@@ -1,5 +1,5 @@
-import { consoleLog } from '../../utils.js';
-import { addConnectors, addOfficialConnectors, inquireInstancePath } from './utils.js';
+import { consoleLog, inquireInstancePath } from '../../utils.js';
+import { addConnectors, addOfficialConnectors } from './utils.js';
 const add = {
     command: ['add [packages...]', 'a', 'install', 'i'],
     describe: 'Add specific Logto connectors',

package/lib/commands/connector/link.js

@@ -1,7 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import { consoleLog } from '../../utils.js';
-import { getConnectorDirectory, getLocalConnectorPackages, inquireInstancePath } from './utils.js';
+import { consoleLog, inquireInstancePath } from '../../utils.js';
+import { getConnectorDirectory, getLocalConnectorPackages } from './utils.js';
 const link = {
     command: ['link', 'ln'],
     describe: 'Link all connectors in `packages/connectors`, useful for adding local connectors.',

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

@@ -5,14 +5,13 @@ export declare const npmPackResultGuard: z.ZodArray<z.ZodObject<{
     filename: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    filename: string;
     version: string;
+    filename: string;
 }, {
     name: string;
-    filename: string;
     version: string;
+    filename: string;
 }>, "many">;
-export declare const inquireInstancePath: (initialPath?: string) => Promise<string>;
 export declare const normalizePackageName: (name: string) => string;
 export declare const getConnectorDirectory: (instancePath: string) => string;
 export declare const isOfficialConnector: (packageName: string) => boolean;

package/lib/commands/connector/utils.js

@@ -3,18 +3,15 @@ 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 { conditionalArray, conditionalString, trySafe } from '@silverhand/essentials';
 import chalk from 'chalk';
 import { got } from 'got';
-import inquirer from 'inquirer';
 import pLimit from 'p-limit';
 import pRetry from 'p-retry';
 import tar from 'tar';
 import { z } from 'zod';
-import { connectorDirectory } from '../../constants.js';
-import { consoleLog, getConnectorPackagesFromDirectory, isTty, oraPromise } from '../../utils.js';
-import { defaultPath } from '../install/utils.js';
-const coreDirectory = 'packages/core';
+import { connectorDirectory, coreDirectory } from '../../constants.js';
+import { consoleLog, getConnectorPackagesFromDirectory, inquireInstancePath, oraPromise, } from '../../utils.js';
 const execPromise = promisify(exec);
 export const npmPackResultGuard = z
     .object({
@@ -23,49 +20,6 @@ export const npmPackResultGuard = z
     filename: z.string(),
 })
     .array();
-const buildPathErrorMessage = (value) => `The path ${chalk.green(value)} does not contain a Logto instance, please try another.`;
-const validatePath = async (value) => {
-    const corePackageJsonPath = path.resolve(path.join(value, coreDirectory, 'package.json'));
-    if (!existsSync(corePackageJsonPath)) {
-        return buildPathErrorMessage(value);
-    }
-    const packageJson = await fs.readFile(corePackageJsonPath, { encoding: 'utf8' });
-    const packageName = await z
-        .object({ name: z.string() })
-        .parseAsync(JSON.parse(packageJson))
-        .then(({ name }) => name)
-        .catch(() => '');
-    if (packageName !== '@logto/core') {
-        return buildPathErrorMessage(value);
-    }
-    return true;
-};
-export const inquireInstancePath = async (initialPath) => {
-    const inquire = async () => {
-        if (!initialPath && (await validatePath('.')) === true) {
-            return path.resolve('.');
-        }
-        if (!isTty()) {
-            assert(initialPath, new Error('Path is missing'));
-            return initialPath;
-        }
-        const { instancePath } = await inquirer.prompt({
-            name: 'instancePath',
-            message: 'Where is your Logto instance?',
-            type: 'input',
-            default: defaultPath,
-            filter: (value) => value.trim(),
-            validate: validatePath,
-        }, { instancePath: initialPath });
-        return instancePath;
-    };
-    const instancePath = await inquire();
-    const validated = await validatePath(instancePath);
-    if (validated !== true) {
-        consoleLog.fatal(validated);
-    }
-    return instancePath;
-};
 const packagePrefix = 'connector-';
 export const normalizePackageName = (name) => name
     .split('/')
@@ -172,7 +126,6 @@ export const fetchOfficialConnectorList = async (includingCloudConnectors = fals
 export const addOfficialConnectors = async (instancePath, includingCloudConnectors = false) => {
     const packages = await oraPromise(fetchOfficialConnectorList(includingCloudConnectors), {
         text: 'Fetch official connector list',
-        prefixText: chalk.blue('[info]'),
     });
     consoleLog.info(`Found ${packages.length} official connectors`);
     await addConnectors(instancePath, packages.map(({ name }) => name));

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

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import { createPoolFromConfig } from '../../../database.js';
 import { getCurrentDatabaseAlterationTimestamp, updateDatabaseTimestamp, } from '../../../queries/system.js';
 import { consoleLog } from '../../../utils.js';
-import { getAlterationFiles, getTimestampFromFilename } from './utils.js';
+import { getAlterationFiles, getTimestampFromFilename, chooseRevertAlterationsByTimestamp, } from './utils.js';
 import { chooseAlterationsByVersion, chooseRevertAlterationsByVersion } from './version.js';
 const importAlterationScript = async (filePath) => {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -52,6 +52,15 @@ const deployAlteration = async (pool, { path: filePath, filename }, action = 'up
     }
     consoleLog.info(`Run alteration ${filename} \`${action}()\` function succeeded`);
 };
+const revertAlterations = async (alterations, pool) => {
+    consoleLog.info(`Found ${alterations.length} alteration${conditionalString(alterations.length > 1 && 's')} to revert`);
+    // The await inside the loop is intended, alterations should run in order
+    // eslint-disable-next-line @silverhand/fp/no-mutating-methods
+    for (const alteration of alterations.slice().reverse()) {
+        // eslint-disable-next-line no-await-in-loop
+        await deployAlteration(pool, alteration, 'down');
+    }
+};
 const alteration = {
     command: ['alteration <action> [target]', 'alt', 'alter'],
     describe: 'Perform database alteration',
@@ -66,37 +75,44 @@ const alteration = {
         type: 'string',
     }),
     handler: async ({ action, target }) => {
-        if (action === 'list') {
-            const files = await getAlterationFiles();
-            for (const file of files) {
-                consoleLog.plain(file.filename);
+        switch (action) {
+            case 'list': {
+                const files = await getAlterationFiles();
+                for (const file of files) {
+                    consoleLog.plain(file.filename);
+                }
+                break;
             }
-        }
-        else if (action === 'deploy') {
-            const pool = await createPoolFromConfig();
-            const alterations = await chooseAlterationsByVersion(await getAvailableAlterations(pool), target);
-            consoleLog.info(`Found ${alterations.length} alteration${conditionalString(alterations.length > 1 && 's')} to deploy`);
-            // The await inside the loop is intended, alterations should run in order
-            for (const alteration of alterations) {
-                // eslint-disable-next-line no-await-in-loop
-                await deployAlteration(pool, alteration);
+            case 'deploy': {
+                const pool = await createPoolFromConfig();
+                const alterations = await chooseAlterationsByVersion(await getAvailableAlterations(pool), target);
+                consoleLog.info(`Found ${alterations.length} alteration${conditionalString(alterations.length > 1 && 's')} to deploy`);
+                // The await inside the loop is intended, alterations should run in order
+                for (const alteration of alterations) {
+                    // eslint-disable-next-line no-await-in-loop
+                    await deployAlteration(pool, alteration);
+                }
+                await pool.end();
+                break;
             }
-            await pool.end();
-        }
-        else if (['rollback', 'r'].includes(action)) {
-            const pool = await createPoolFromConfig();
-            const alterations = await chooseRevertAlterationsByVersion(await getAvailableAlterations(pool, 'lte'), target ?? '');
-            consoleLog.info(`Found ${alterations.length} alteration${conditionalString(alterations.length > 1 && 's')} to revert`);
-            // The await inside the loop is intended, alterations should run in order
-            // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-            for (const alteration of alterations.slice().reverse()) {
-                // eslint-disable-next-line no-await-in-loop
-                await deployAlteration(pool, alteration, 'down');
+            case 'rollback':
+            case 'r': {
+                const pool = await createPoolFromConfig();
+                const alterations = await chooseRevertAlterationsByVersion(await getAvailableAlterations(pool, 'lte'), target ?? '');
+                await revertAlterations(alterations, pool);
+                await pool.end();
+                break;
+            }
+            case 'rollback-to-timestamp': {
+                const pool = await createPoolFromConfig();
+                const alterations = await chooseRevertAlterationsByTimestamp(target ?? '');
+                await revertAlterations(alterations, pool);
+                await pool.end();
+                break;
+            }
+            default: {
+                consoleLog.fatal('Unsupported action');
             }
-            await pool.end();
-        }
-        else {
-            consoleLog.fatal('Unsupported action');
         }
     },
 };

package/lib/commands/database/alteration/utils.d.ts

@@ -2,3 +2,4 @@ import type { AlterationFile } from './type.js';
 export declare const getTimestampFromFilename: (filename: string) => number;
 export declare const getAlterationDirectory: () => string;
 export declare const getAlterationFiles: () => Promise<AlterationFile[]>;
+export declare const chooseRevertAlterationsByTimestamp: (target: string) => Promise<AlterationFile[]>;

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

@@ -36,3 +36,11 @@ export const getAlterationFiles = async () => {
         .sort((file1, file2) => getTimestampFromFilename(file1) - getTimestampFromFilename(file2))
         .map((filename) => ({ path: path.join(localAlterationDirectory, filename), filename }));
 };
+export const chooseRevertAlterationsByTimestamp = async (target) => {
+    const files = await getAlterationFiles();
+    const targetTimestamp = Number(target);
+    if (Number.isNaN(targetTimestamp)) {
+        return [];
+    }
+    return files.filter(({ filename }) => getTimestampFromFilename(filename) > targetTimestamp);
+};

package/lib/commands/database/config.js

@@ -4,7 +4,7 @@ import chalk from 'chalk';
 import { createPoolFromConfig } from '../../database.js';
 import { getRowsByKeys, updateValueByKey } from '../../queries/logto-config.js';
 import { consoleLog } from '../../utils.js';
-import { generateOidcCookieKey, generateOidcPrivateKey } from './utils.js';
+import { PrivateKeyType, generateOidcCookieKey, generateOidcPrivateKey } from './utils.js';
 const validKeysDisplay = chalk.green(logtoConfigKeys.join(', '));
 const validateKeys = (keys) => {
     const invalidKey = (Array.isArray(keys) ? keys : [keys]).find(
@@ -19,6 +19,7 @@ const validRotateKeys = Object.freeze([
     LogtoOidcConfigKey.PrivateKeys,
     LogtoOidcConfigKey.CookieKeys,
 ]);
+const validPrivateKeyTypes = Object.freeze([PrivateKeyType.RSA, PrivateKeyType.EC]);
 const validateRotateKey = (key) => {
     // Using `.includes()` will result a type error
     // eslint-disable-next-line unicorn/prefer-includes
@@ -26,6 +27,13 @@ const validateRotateKey = (key) => {
         consoleLog.fatal(`Invalid config key ${chalk.red(key)} found, expected one of ${validKeysDisplay}`);
     }
 };
+const validatePrivateKeyType = (key) => {
+    // Using `.includes()` will result a type error
+    // eslint-disable-next-line unicorn/prefer-includes
+    if (!validPrivateKeyTypes.some((element) => element === key)) {
+        consoleLog.fatal(`Invalid private key type ${chalk.red(key)} found, expected one of ${validPrivateKeyTypes.join(', ')}`);
+    }
+};
 const getConfig = {
     command: 'get <key> [keys...]',
     describe: 'Get config value(s) of the given key(s) in Logto database',
@@ -103,9 +111,15 @@ const rotateConfig = {
         describe: 'The tenant to operate',
         type: 'string',
         default: defaultTenantId,
+    })
+        .option('type', {
+        describe: `The key type for ${LogtoOidcConfigKey.PrivateKeys}, one of ${validPrivateKeyTypes.join(', ')}`,
+        type: 'string',
+        default: 'ec',
     }),
-    handler: async ({ key, tenantId }) => {
+    handler: async ({ key, tenantId, type }) => {
         validateRotateKey(key);
+        validatePrivateKeyType(type);
         const pool = await createPoolFromConfig();
         const { rows } = await getRowsByKeys(pool, tenantId, [key]);
         if (!rows[0]) {
@@ -117,7 +131,7 @@ const rotateConfig = {
             // No need for default. It's already exhaustive
             switch (key) {
                 case LogtoOidcConfigKey.PrivateKeys: {
-                    return [await generateOidcPrivateKey(), ...original];
+                    return [await generateOidcPrivateKey(type), ...original];
                 }
                 case LogtoOidcConfigKey.CookieKeys: {
                     return [generateOidcCookieKey(), ...original];

package/lib/commands/database/seed/cloud.d.ts

@@ -8,3 +8,11 @@ import type { CommonQueryMethods } from 'slonik';
  * For why it is necessary, see the redirect lifecycle of cloud Admin Console.
  */
 export declare const appendAdminConsoleRedirectUris: (pool: CommonQueryMethods) => Promise<void>;
+/**
+ * Create Cloud Service M2M application for the tenant.
+ *
+ * This is a built-in M2M application for the tenant to communicate with the cloud service.
+ * - default
+ * - admin
+ */
+export declare const seedTenantCloudServiceApplication: (pool: CommonQueryMethods, tenantId: string) => Promise<void>;

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

@@ -1,7 +1,8 @@
-import { adminConsoleApplicationId, adminTenantId, defaultTenantId } from '@logto/schemas';
+import { adminConsoleApplicationId, adminTenantId, defaultTenantId, createTenantMachineToMachineApplication, createAdminTenantApplicationRole, createCloudConnectionConfig, AdminTenantRole, } from '@logto/schemas';
 import { GlobalValues } from '@logto/shared';
 import { appendPath } from '@silverhand/essentials';
 import { sql } from 'slonik';
+import { insertInto } from '../../../database.js';
 import { consoleLog } from '../../../utils.js';
 /**
  * Append Redirect URIs for the default tenant callback in cloud Admin Console.
@@ -32,3 +33,25 @@ export const appendAdminConsoleRedirectUris = async (pool) => {
   `);
     consoleLog.succeed('Appended initial Redirect URIs to Admin Console:', redirectUris.map(String));
 };
+/**
+ * Create Cloud Service M2M application for the tenant.
+ *
+ * This is a built-in M2M application for the tenant to communicate with the cloud service.
+ * - default
+ * - admin
+ */
+export const seedTenantCloudServiceApplication = async (pool, tenantId) => {
+    // Create Cloud Service M2M application
+    const cloudServiceApplication = createTenantMachineToMachineApplication(tenantId);
+    await pool.query(insertInto(cloudServiceApplication, 'applications'));
+    // Assign tenantApplicationRole to Cloud Service M2M application
+    const { id: tenantApplicationRoleId } = await pool.one(sql `
+    select id from roles
+    where name = ${AdminTenantRole.TenantApplication}
+    and tenant_id = ${adminTenantId}
+  `);
+    await pool.query(insertInto(createAdminTenantApplicationRole(cloudServiceApplication.id, tenantApplicationRoleId), 'applications_roles'));
+    // Create Cloud Service M2M application logto_config
+    await pool.query(insertInto(createCloudConnectionConfig(tenantId, cloudServiceApplication.id, cloudServiceApplication.secret), 'logto_configs'));
+    consoleLog.succeed('Cloud Service Application successfully created for:', tenantId);
+};

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

@@ -1,4 +1,3 @@
-import chalk from 'chalk';
 import { createPoolAndDatabaseIfNeeded } from '../../../database.js';
 import { doesConfigsTableExist } from '../../../queries/logto-config.js';
 import { consoleLog, oraPromise } from '../../../utils.js';
@@ -15,7 +14,6 @@ export const seedByPool = async (pool, cloud = false) => {
         }
         await oraPromise(createTables(connection), {
             text: 'Create tables',
-            prefixText: chalk.blue('[info]'),
         });
         await seedTables(connection, latestTimestamp, cloud);
         if (cloud) {

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

@@ -36,10 +36,10 @@ export const seedOidcConfigs = async (pool, tenantId) => {
     for (const key of validOptions) {
         const { value, fromEnv } = await oidcConfigReaders[key]();
         if (fromEnv) {
-            consoleLog.info(tenantPrefix, `Read config ${chalk.green(key)} from env`);
+            consoleLog.succeed(tenantPrefix, `Read config ${chalk.green(key)} from env`);
         }
         else {
-            consoleLog.info(tenantPrefix, `Generated config ${chalk.green(key)}`);
+            consoleLog.succeed(tenantPrefix, `Generated config ${chalk.green(key)}`);
         }
         await updateValueByKey(pool, tenantId, key, value);
     }

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

@@ -1,6 +1,6 @@
 import { readdir, readFile } from 'node:fs/promises';
 import path from 'node:path';
-import { createDefaultAdminConsoleConfig, createCloudConnectionConfig, defaultTenantId, adminTenantId, defaultManagementApi, createAdminDataInAdminTenant, createMeApiInAdminTenant, createDefaultSignInExperience, createAdminTenantSignInExperience, createDefaultAdminConsoleApplication, createCloudApi, createTenantApplicationRole, createTenantMachineToMachineApplication, createAdminTenantApplicationRole, CloudScope, } from '@logto/schemas';
+import { createDefaultAdminConsoleConfig, defaultTenantId, adminTenantId, defaultManagementApi, createAdminDataInAdminTenant, createMeApiInAdminTenant, createDefaultSignInExperience, createAdminTenantSignInExperience, createDefaultAdminConsoleApplication, createCloudApi, createTenantApplicationRole, CloudScope, } from '@logto/schemas';
 import { Tenants } from '@logto/schemas/models';
 import { sql } from 'slonik';
 import { raw } from 'slonik-sql-tag-raw';
@@ -8,7 +8,7 @@ import { insertInto } from '../../../database.js';
 import { getDatabaseName } from '../../../queries/database.js';
 import { updateDatabaseTimestamp } from '../../../queries/system.js';
 import { consoleLog, getPathInModule } from '../../../utils.js';
-import { appendAdminConsoleRedirectUris } from './cloud.js';
+import { appendAdminConsoleRedirectUris, seedTenantCloudServiceApplication } from './cloud.js';
 import { seedOidcConfigs } from './oidc-config.js';
 import { assignScopesToRole, createTenant, seedAdminData } from './tenant.js';
 const getExplicitOrder = (query) => {
@@ -82,23 +82,21 @@ export const seedTables = async (connection, latestTimestamp, isCloud) => {
     await seedAdminData(connection, adminAdminData);
     await seedAdminData(connection, createMeApiInAdminTenant());
     const [cloudData, ...cloudAdditionalScopes] = createCloudApi();
-    const applicationRole = createTenantApplicationRole();
     await seedAdminData(connection, cloudData, ...cloudAdditionalScopes);
+    // Create tenant application role
+    const applicationRole = createTenantApplicationRole();
     await connection.query(insertInto(applicationRole, 'roles'));
     await assignScopesToRole(connection, adminTenantId, applicationRole.id, ...cloudAdditionalScopes
         .filter(({ name }) => name === CloudScope.SendSms || name === CloudScope.SendEmail)
         .map(({ id }) => id));
-    // Add M2M app for default tenant
-    const defaultTenantApplication = createTenantMachineToMachineApplication(defaultTenantId);
-    await connection.query(insertInto(defaultTenantApplication, 'applications'));
-    await connection.query(insertInto(createAdminTenantApplicationRole(defaultTenantApplication.id, applicationRole.id), 'applications_roles'));
     // Assign all cloud API scopes to role `admin:admin`
     await assignScopesToRole(connection, adminTenantId, adminAdminData.role.id, ...cloudAdditionalScopes.map(({ id }) => id));
+    // FIXME: @wangsijie should not create tenant Cloud Service application in the OSS DB.
+    await seedTenantCloudServiceApplication(connection, defaultTenantId);
     await Promise.all([
         connection.query(insertInto(createDefaultAdminConsoleConfig(defaultTenantId), 'logto_configs')),
-        connection.query(insertInto(createCloudConnectionConfig(defaultTenantId, defaultTenantApplication.id, defaultTenantApplication.secret), 'logto_configs')),
-        connection.query(insertInto(createDefaultSignInExperience(defaultTenantId, isCloud), 'sign_in_experiences')),
         connection.query(insertInto(createDefaultAdminConsoleConfig(adminTenantId), 'logto_configs')),
+        connection.query(insertInto(createDefaultSignInExperience(defaultTenantId, isCloud), 'sign_in_experiences')),
         connection.query(insertInto(createAdminTenantSignInExperience(), 'sign_in_experiences')),
         connection.query(insertInto(createDefaultAdminConsoleApplication(), 'applications')),
         updateDatabaseTimestamp(connection, latestTimestamp),
@@ -106,5 +104,8 @@ export const seedTables = async (connection, latestTimestamp, isCloud) => {
     consoleLog.succeed('Seed data');
 };
 export const seedCloud = async (connection) => {
-    await appendAdminConsoleRedirectUris(connection);
+    await Promise.all([
+        appendAdminConsoleRedirectUris(connection),
+        seedTenantCloudServiceApplication(connection, adminTenantId),
+    ]);
 };

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

@@ -1,2 +1,6 @@
-export declare const generateOidcPrivateKey: (type?: 'rsa' | 'ec') => Promise<string>;
+export declare enum PrivateKeyType {
+    RSA = "rsa",
+    EC = "ec"
+}
+export declare const generateOidcPrivateKey: (type?: PrivateKeyType) => Promise<string>;
 export declare const generateOidcCookieKey: () => string;

package/lib/commands/database/utils.js

@@ -1,8 +1,13 @@
 import { generateKeyPair } from 'node:crypto';
 import { promisify } from 'node:util';
 import { generateStandardId } from '@logto/shared';
-export const generateOidcPrivateKey = async (type = 'ec') => {
-    if (type === 'rsa') {
+export var PrivateKeyType;
+(function (PrivateKeyType) {
+    PrivateKeyType["RSA"] = "rsa";
+    PrivateKeyType["EC"] = "ec";
+})(PrivateKeyType || (PrivateKeyType = {}));
+export const generateOidcPrivateKey = async (type = PrivateKeyType.EC) => {
+    if (type === PrivateKeyType.RSA) {
         const { privateKey } = await promisify(generateKeyPair)('rsa', {
             modulusLength: 4096,
             publicKeyEncoding: {
@@ -17,7 +22,7 @@ export const generateOidcPrivateKey = async (type = 'ec') => {
         return privateKey;
     }
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (type === 'ec') {
+    if (type === PrivateKeyType.EC) {
         const { privateKey } = await promisify(generateKeyPair)('ec', {
             // https://security.stackexchange.com/questions/78621/which-elliptic-curve-should-i-use
             namedCurve: 'secp384r1',

package/lib/commands/install/index.js

@@ -1,27 +1,27 @@
 import chalk from 'chalk';
 import { getDatabaseUrlFromConfig } from '../../database.js';
 import { consoleLog } from '../../utils.js';
-import { validateNodeVersion, inquireInstancePath, validateDatabase, downloadRelease, seedDatabase, createEnv, logFinale, decompress, isUrl, } from './utils.js';
+import { validateNodeVersion, inquireInstallPath, validateDatabase, downloadRelease, seedDatabase, createEnv, logFinale, decompress, isUrl, } from './utils.js';
 const installLogto = async ({ path, skipSeed, downloadUrl, cloud }) => {
     validateNodeVersion();
-    // Get instance path
-    const instancePath = await inquireInstancePath(path);
+    // Get install location path
+    const installPath = await inquireInstallPath(path);
     // Validate if user has a valid database
     await validateDatabase();
     // Download and decompress
     const tarPath = !downloadUrl || isUrl(downloadUrl) ? await downloadRelease(downloadUrl) : downloadUrl;
-    await decompress(instancePath, tarPath);
+    await decompress(installPath, tarPath);
     // Seed database
     if (skipSeed) {
         consoleLog.info(`Skipped database seeding.\n\n' + '  You can use the ${chalk.green('db seed')} command to seed database when ready.\n`);
     }
     else {
-        await seedDatabase(instancePath, cloud);
+        await seedDatabase(installPath, cloud);
     }
     // Save to dot env
-    await createEnv(instancePath, await getDatabaseUrlFromConfig());
+    await createEnv(installPath, await getDatabaseUrlFromConfig());
     // Finale
-    logFinale(instancePath);
+    logFinale(installPath);
 };
 const install = {
     command: ['init', 'i', 'install'],

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

@@ -1,10 +1,9 @@
-export declare const defaultPath: string;
 export declare const validateNodeVersion: () => void;
-export declare const inquireInstancePath: (initialPath?: string) => Promise<string>;
+export declare const inquireInstallPath: (initialPath?: string) => Promise<string>;
 export declare const validateDatabase: () => Promise<void>;
 export declare const downloadRelease: (url?: string) => Promise<string>;
 export declare const decompress: (toPath: string, tarPath: string) => Promise<void>;
 export declare const seedDatabase: (instancePath: string, cloud: boolean) => Promise<void>;
-export declare const createEnv: (instancePath: string, databaseUrl: string) => Promise<void>;
-export declare const logFinale: (instancePath: string) => void;
+export declare const createEnv: (installPath: string, databaseUrl: string) => Promise<void>;
+export declare const logFinale: (installPath: string) => void;
 export declare const isUrl: (string: string) => boolean;

package/lib/commands/install/utils.js

@@ -9,11 +9,11 @@ import { got, RequestError } from 'got';
 import inquirer from 'inquirer';
 import * as semver from 'semver';
 import tar from 'tar';
+import { defaultPath } from '../../constants.js';
 import { createPoolAndDatabaseIfNeeded } from '../../database.js';
 import { packageJson } from '../../package-json.js';
 import { cliConfig, ConfigKey, consoleLog, downloadFile, isTty, oraPromise, safeExecSync, } from '../../utils.js';
 import { seedByPool } from '../database/seed/index.js';
-export const defaultPath = path.join(os.homedir(), 'logto');
 const pgRequired = new semver.SemVer('14.0.0');
 export const validateNodeVersion = () => {
     const required = [new semver.SemVer('18.12.0')];
@@ -29,7 +29,7 @@ export const validateNodeVersion = () => {
 const validatePath = (value) => existsSync(path.resolve(value))
     ? `The path ${chalk.green(value)} already exists, please try another.`
     : true;
-export const inquireInstancePath = async (initialPath) => {
+export const inquireInstallPath = async (initialPath) => {
     if (!isTty()) {
         assert(initialPath, new Error('Path is missing'));
         return initialPath;
@@ -106,7 +106,6 @@ export const decompress = async (toPath, tarPath) => {
     };
     return oraPromise(run(), {
         text: `Decompress to ${toPath}`,
-        prefixText: chalk.blue('[info]'),
     }, true);
 };
 export const seedDatabase = async (instancePath, cloud) => {
@@ -119,19 +118,18 @@ export const seedDatabase = async (instancePath, cloud) => {
         consoleLog.error(error);
         await oraPromise(fs.rm(instancePath, { force: true, recursive: true }), {
             text: 'Clean up',
-            prefixText: chalk.blue('[info]'),
         });
         consoleLog.fatal('Error occurred during seeding your Logto database. Nothing has changed since the seeding process was in a transaction.\n\n' +
             `  To skip the database seeding, append ${chalk.green('--skip-seed')} to the command options.`);
     }
 };
-export const createEnv = async (instancePath, databaseUrl) => {
-    const dotEnvPath = path.resolve(instancePath, '.env');
+export const createEnv = async (installPath, databaseUrl) => {
+    const dotEnvPath = path.resolve(installPath, '.env');
     await fs.writeFile(dotEnvPath, `DB_URL=${databaseUrl}`, 'utf8');
     consoleLog.info(`Saved database URL to ${chalk.blue(dotEnvPath)}`);
 };
-export const logFinale = (instancePath) => {
-    const startCommand = `cd ${instancePath} && npm start`;
+export const logFinale = (installPath) => {
+    const startCommand = `cd ${installPath} && npm start`;
     consoleLog.info(`Use the command below to start Logto. Happy hacking!\n\n  ${chalk.green(startCommand)}`);
 };
 export const isUrl = (string) => {

package/lib/commands/translate/create.js

@@ -1,8 +1,7 @@
 import { isLanguageTag } from '@logto/language-kit';
 import { isBuiltInLanguageTag as isPhrasesBuiltInLanguageTag } from '@logto/phrases';
-import { isBuiltInLanguageTag as isPhrasesUiBuiltInLanguageTag } from '@logto/phrases-ui';
-import { consoleLog } from '../../utils.js';
-import { inquireInstancePath } from '../connector/utils.js';
+import { isBuiltInLanguageTag as isPhrasesUiBuiltInLanguageTag } from '@logto/phrases-experience';
+import { consoleLog, inquireInstancePath } from '../../utils.js';
 import { createFullTranslation } from './utils.js';
 const create = {
     command: ['create <language-tag>', 'c'],
@@ -26,11 +25,11 @@ const create = {
             languageTag,
         });
         if (isPhrasesUiBuiltInLanguageTag(languageTag)) {
-            consoleLog.info(languageTag + ' is a built-in tag of phrases-ui, updating untranslated phrases');
+            consoleLog.info(languageTag + ' is a built-in tag of phrases-experience, updating untranslated phrases');
         }
         await createFullTranslation({
             instancePath,
-            packageName: 'phrases-ui',
+            packageName: 'phrases-experience',
             languageTag,
         });
     },

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

@@ -1,6 +1,6 @@
 import { languages } from '@logto/language-kit';
 import { isBuiltInLanguageTag as isPhrasesBuiltInLanguageTag } from '@logto/phrases';
-import { isBuiltInLanguageTag as isPhrasesUiBuiltInLanguageTag } from '@logto/phrases-ui';
+import { isBuiltInLanguageTag as isPhrasesUiBuiltInLanguageTag } from '@logto/phrases-experience';
 import chalk from 'chalk';
 import { consoleLog } from '../../utils.js';
 const listTags = {
@@ -11,7 +11,7 @@ const listTags = {
             consoleLog.plain(...[
                 tag,
                 isPhrasesBuiltInLanguageTag(tag) && chalk.blue('phrases'),
-                isPhrasesUiBuiltInLanguageTag(tag) && chalk.blue('phrases-ui'),
+                isPhrasesUiBuiltInLanguageTag(tag) && chalk.blue('phrases-experience'),
             ].filter(Boolean));
         }
     },

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

@@ -4,9 +4,10 @@ type GetTranslationPromptProperties = {
     targetLanguage: LanguageTag;
     extraPrompt?: string;
 };
+export declare const untranslatedMark = "/** UNTRANSLATED */";
 /**
  * Note:
- * The input token limit of GPT 3.5 is 2048, the following prompt tokens with sourceFileContent is about 1200.
+ * The input token limit of GPT 3.5 is 2048, the following prompt tokens with sourceFileContent is about 1600.
  * Remember to check the token limit before adding more prompt.
  * Tokens can be counted in https://platform.openai.com/tokenizer
  */