@nocobase/cli 2.2.0-test.15 → 2.2.0

package/dist/lib/portal-template.js

@@ -1,190 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-import { cp, mkdir, mkdtemp, rm, stat } from 'node:fs/promises';
-import os from 'node:os';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { buildPortalCommandEnv } from './portal-command-env.js';
-import { resolvePortalTemplate } from './portal-create.js';
-import { run } from './run-npm.js';
-const DEFAULT_PORTAL_APP_NAME = 'main';
-const DEFAULT_PORTAL_NAME = 'admin';
-const PORTAL_CLIENT_PREFIX = 'x';
-function trimValue(value) {
-    return String(value ?? '').trim();
-}
-function normalizePortalName(value) {
-    const segment = String(value || '')
-        .trim()
-        .replace(/^\/+|\/+$/g, '');
-    return segment || DEFAULT_PORTAL_NAME;
-}
-function normalizePortalAppName(value) {
-    const segment = String(value || '')
-        .trim()
-        .replace(/^\/+|\/+$/g, '');
-    return segment || DEFAULT_PORTAL_APP_NAME;
-}
-function validatePortalSegment(kind, value) {
-    if (!/^[a-zA-Z0-9][a-zA-Z0-9_-]*$/.test(value)) {
-        throw new Error(`Invalid ${kind} "${value}". Use letters, numbers, underscores, or hyphens, and start with a letter or number.`);
-    }
-}
-async function pathExists(filePath) {
-    try {
-        await stat(filePath);
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-function resolveLocalTemplatePath(templateSource) {
-    if (templateSource.startsWith('file://')) {
-        return fileURLToPath(templateSource);
-    }
-    return templateSource;
-}
-function isGitTemplateSource(templateSource) {
-    return (templateSource.startsWith('git@') ||
-        templateSource.startsWith('git+') ||
-        /^https?:\/\//i.test(templateSource) ||
-        templateSource.endsWith('.git'));
-}
-async function getLocalTemplateDir(templateSource) {
-    let localPath;
-    try {
-        localPath = resolveLocalTemplatePath(templateSource);
-    }
-    catch {
-        return undefined;
-    }
-    let result;
-    try {
-        result = await stat(localPath);
-    }
-    catch {
-        return undefined;
-    }
-    if (!result.isDirectory()) {
-        throw new Error(`Portal template "${templateSource}" is invalid: expected a directory.`);
-    }
-    return localPath;
-}
-async function resolveInitialPortalTemplate(params) {
-    const localTemplateDir = await getLocalTemplateDir(params.templateSource);
-    if (localTemplateDir) {
-        return {
-            dir: localTemplateDir,
-            source: params.templateSource,
-            type: 'local',
-        };
-    }
-    if (!isGitTemplateSource(params.templateSource)) {
-        return resolvePortalTemplate(params.templateSource, {
-            npmRegistry: params.npmRegistry,
-            runCommand: params.runCommand,
-        });
-    }
-    await params.runCommand('git', ['clone', '--depth', '1', params.templateSource, params.tempDir], {
-        errorName: 'git clone',
-        stdio: params.verbose ? 'inherit' : 'ignore',
-    });
-    return {
-        dir: params.tempDir,
-        source: params.templateSource,
-        type: 'local',
-    };
-}
-async function copyTemplate(sourceDir, targetDir) {
-    await mkdir(path.dirname(targetDir), { recursive: true });
-    await cp(sourceDir, targetDir, {
-        recursive: true,
-        filter: (source) => !source.split(path.sep).includes('.git'),
-    });
-}
-async function buildPortalHtml(params) {
-    const stdio = params.verbose ? 'inherit' : 'ignore';
-    await params.runCommand('yarn', ['build:html'], {
-        cwd: params.portalDir,
-        env: buildPortalCommandEnv({
-            NOCOBASE_API_URL: '/api',
-            NOCOBASE_PORTAL_BASE: `/${PORTAL_CLIENT_PREFIX}/${params.portalName}/`,
-        }),
-        envMode: 'replace',
-        errorName: 'yarn build:html',
-        stdio,
-    });
-}
-export async function prepareInitialPortalTemplate(options) {
-    const developmentMode = trimValue(options.developmentMode);
-    if (developmentMode !== 'vibe-coding') {
-        return { prepared: false, skippedReason: 'no-code' };
-    }
-    const storagePath = trimValue(options.storagePath);
-    if (!storagePath) {
-        throw new Error('Cannot prepare an initial Portal template without a storage path.');
-    }
-    const templateUrl = trimValue(options.portalTemplate);
-    if (!templateUrl) {
-        throw new Error('Initial Portal template is required when development mode is "vibe-coding".');
-    }
-    const appName = normalizePortalAppName(options.appName);
-    const portalName = normalizePortalName(options.portalName);
-    validatePortalSegment('portal app name', appName);
-    validatePortalSegment('Portal name', portalName);
-    const portalDir = path.join(storagePath, 'portals', appName, portalName);
-    if (await pathExists(portalDir)) {
-        if (await pathExists(path.join(portalDir, 'dist', 'index.html'))) {
-            return { prepared: false, skippedReason: 'already-prepared' };
-        }
-        await rm(portalDir, { recursive: true, force: true });
-    }
-    options.onStartTask?.(`Preparing Portal "${portalName}" from template...`);
-    const runCommand = options.runCommand ?? run;
-    const tempDir = await mkdtemp(path.join(os.tmpdir(), 'nocobase-portal-template-'));
-    let cleanupPortalDir = false;
-    let template;
-    try {
-        template = await resolveInitialPortalTemplate({
-            templateSource: templateUrl,
-            tempDir,
-            npmRegistry: options.npmRegistry,
-            verbose: options.verbose,
-            runCommand,
-        });
-        const templateDir = template.dir;
-        if (!(await pathExists(path.join(templateDir, 'package.json')))) {
-            throw new Error(`Portal template "${templateUrl}" is invalid: package.json is missing.`);
-        }
-        cleanupPortalDir = true;
-        await copyTemplate(templateDir, portalDir);
-        await rm(path.join(portalDir, 'node_modules'), { recursive: true, force: true });
-        await buildPortalHtml({
-            portalDir,
-            portalName,
-            verbose: options.verbose,
-            runCommand,
-        });
-        cleanupPortalDir = false;
-        options.onSucceedTask?.(`Portal "${portalName}" is ready.`);
-        return { prepared: true };
-    }
-    catch (error) {
-        if (cleanupPortalDir) {
-            await rm(portalDir, { recursive: true, force: true });
-        }
-        options.onFailTask?.(`Failed to prepare Portal "${portalName}".`);
-        throw error;
-    }
-    finally {
-        await rm(tempDir, { recursive: true, force: true });
-        await template?.cleanup?.();
-    }
-}