tt-minigame-ide-cli 1.0.2 → 2.0.0-alpha.1

package/dist/tt-ide-cli/src/features/microgame/cloud-compile.d.ts

@@ -0,0 +1,75 @@
+import { ServerSize } from '@byted/miniprogram-utils/typings/project';
+import { ProjectInfo, QrcodeInfo } from '../../types';
+import { IMetrics } from '../../utils/metrics';
+import { IDEConfig, MakeSchemaOption } from '../../utils/qrcode';
+export declare type ProjectQRCode = {
+    expireTime: number;
+    shortUrl: string;
+    originSchema: string;
+    qrcodeSVG?: string;
+    qrcodeFilePath?: string;
+    useCache: boolean;
+} & Pick<CompileProgressResult, 'metrics' | 'passJson'>;
+declare type CompileProgressResult = {
+    success: boolean;
+    /** error code */
+    error: number;
+    done: boolean;
+    msg: string;
+    metrics?: IMetrics;
+    errLink?: string;
+    passJson: {
+        packageSize?: ServerSize;
+    } & Record<string, any>;
+};
+export declare type PreviewOption = Pick<ProjectToQRCodeOption, 'project' | 'page' | 'qrcode' | 'cache' | 'copyToClipboard' | 'extraInfoJson' | 'localCompileVersion' | 'ideConfig'>;
+/**
+ * 预览上传（功能入口）
+ * @param options
+ * @returns
+ */
+export declare function preview(options: PreviewOption): Promise<ProjectQRCode>;
+export declare type UploadOption = Pick<ProjectToQRCodeOption, 'project' | 'qrcode' | 'copyToClipboard' | 'extraInfoJson' | 'localCompileVersion' | 'ideConfig'> & {
+    version: string;
+    changeLog: string;
+    needUploadSourcemap?: boolean;
+};
+/**
+ * 发布上传（功能入口）
+ * @param options
+ * @returns
+ */
+export declare function upload(options: UploadOption): Promise<ProjectQRCode>;
+export declare type ProjectToQRCodeOption = {
+    project: ProjectInfo;
+    page: {
+        path: string;
+        query: string;
+        scene: string;
+        launchFrom: string;
+        location: string;
+    } & Pick<MakeSchemaOption, 'referrerInfo'>;
+    qrcode: QrcodeInfo;
+    cache: boolean;
+    copyToClipboard: boolean;
+    uploadOptions?: {
+        version: string;
+        changeLog: string;
+        needUploadSourcemap: boolean;
+    };
+    extraInfoJson?: string;
+    localCompileVersion?: string;
+    ideConfig?: IDEConfig;
+    debug?: {
+        query: {
+            gtoken: string;
+            roomid: string;
+            session: string;
+        };
+    };
+    uploadCache?: boolean;
+    supportSourcemap?: boolean;
+    enableHotRestartCache?: boolean;
+};
+export declare function projectToQRCode(options: ProjectToQRCodeOption): Promise<ProjectQRCode>;
+export {};

package/dist/tt-ide-cli/src/features/microgame/index.d.ts

@@ -0,0 +1,3 @@
+export * from './cloud-compile';
+export * from './utils/package';
+export * from './meta';

package/dist/tt-ide-cli/src/features/microgame/meta.d.ts

@@ -0,0 +1 @@
+export declare const getMeta: (appId: string) => Promise<any>;

package/dist/tt-ide-cli/src/features/microgame/utils/file-system.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 文件系统相关
+ */
+/** MB 转 Byte 数，即 mb * 1024 * 1024 */
+export declare const mb2Byte: (mb: number) => number;
+/** Byte size 转 MB，即 byte / 1024 / 1024，默认保留 4 位小数 */
+export declare const byte2Mb: (byte: number, fixed?: number) => number;
+/** 获取文件字节数体积，实际上文件夹也支持，获取的是文件夹本身占用的系统体积（测试为 128Byte） */
+export declare const getFileByteSize: (path: string) => number;
+/** 获取指定目录下所有文件体积和，支持 glob pattern ignore */
+export declare const getDirByteSize: (path: string, ignore?: any[]) => Promise<number>;
+/** 获取指定路径（兼容文件 / 整个目录）大小 Byte 数 */
+export declare const getPathByteSize: (path: string, ignore?: any[]) => number | Promise<number>;

package/dist/tt-ide-cli/src/features/microgame/utils/package.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 小游戏源码、打包相关
+ */
+/** 不参与体积计算的 glob pattern */
+export declare const PKG_SIZE_IGNORE_GLOBS: string[];
+/** 计算包哈希时不参与计算的文件匹配规则 */
+export declare const PKG_HASH_IGNORE_LIST: string[];
+/**
+ * 校验包体大小，支持白名单逻辑，具体限制以 Settings 下发为准
+ * 默认：普通包最大 8MB，开放数据域 & 分包主包最大 4MB，子包不限制，总包 20MB
+ * 体积计算：忽略 dot 文件、node_modules、map 文件等，加上目录体积参与计算，计算结果一般和系统显示的不同
+ * 保持逻辑严谨，尽量给到用户足够详细、有信息量的检查结果提示
+ * @param root 小游戏路径
+ * @returns 错误信息，空串表示校验通过
+ */
+export declare const verifyPkgSize: (root: string) => Promise<string>;
+export declare const getDirHash: (dirPath: string) => Promise<string>;
+export declare function compressZip(filePath: string, tempStoragePath: string, extraIgnore?: string[]): Promise<string>;
+export declare const checkUCAppId: (appId: string) => boolean;
+export declare const checkAppId: (appId: string) => boolean;
+export declare const getAppId: (projectPath: string) => Promise<string>;
+export declare const validateAppId: (appId: string) => Promise<void>;

package/dist/tt-ide-cli/src/features/microgame/utils/settings.d.ts

@@ -0,0 +1,48 @@
+/**
+ * AppSettings 相关逻辑封装
+ * https://site.bytedance.net/docs/428/3356/request_params/
+ */
+import { SizeLimitConfig, TmgSdkInfo } from './source.type';
+/**
+ * 网络请求相关相关的 typings 声明
+ */
+declare type BaseResponse<T = any> = {
+    data: T;
+    message: string;
+};
+declare type Dict<T = any> = {
+    [key: string]: T;
+};
+export declare type SettingsResponse = BaseResponse<{
+    settings: {
+        compile_config?: {
+            limit: SizeLimitConfig;
+        };
+        tt_tma_sdk_config?: TmgSdkInfo[];
+    };
+    settings_time: number;
+}>;
+export declare const SETTINGS_URL = "https://is.snssdk.com/service/settings/v3/";
+export declare const genDefault: (params: Dict) => {
+    caller_name: string;
+    channel: string;
+    device_platform: string;
+    device_id: any;
+    device_id_str: any;
+    version_code: any;
+    user_id: any;
+};
+/**
+ * 获取小游戏 IDE AppSettings 配置
+ * https://cloud.bytedance.net/appSettings-v2/detail/product/608/config/list
+ */
+export declare const getIdeSettings: (params?: Dict) => Promise<{
+    settings: {
+        compile_config?: {
+            limit: SizeLimitConfig;
+        };
+        tt_tma_sdk_config?: TmgSdkInfo[];
+    };
+    settings_time: number;
+}>;
+export {};

package/dist/tt-ide-cli/src/features/microgame/utils/source.type.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 跟小游戏源码包相关的 typings 声明
+ */
+export declare type ProjectConfigInfo = {
+    /** 小游戏 AppId */
+    appid: string;
+};
+export declare type SubPackageInfo = {
+    root: string;
+    name: string;
+};
+export declare type GameInfo = {
+    /** 分包子包配置（兼容 subpackages） */
+    subPackages?: SubPackageInfo[];
+    /** 分包子包配置（兼容 subPackages） */
+    subpackages?: SubPackageInfo[];
+    /** 开放数据域配置 */
+    openDataContext?: string;
+};
+export declare type SizeLimitConfig = {
+    /** 普通非分包整包最大 MB 数 */
+    normalTotal: number;
+    /** 分包主包最大 MB 数 */
+    subMain: number;
+    /** 分包子包最大 MB 数 */
+    subPkg: number;
+    /** 分包整包最大 MB 数 */
+    subTotal: number;
+    /** 开放数据域包最大 MB 数 */
+    openData: number;
+};
+export declare type TmgSdkInfo = {
+    latestSDKUrl: string;
+    sdkUpdateVersion: string;
+};

package/dist/tt-ide-cli/src/features/npm.d.ts

@@ -0,0 +1,10 @@
+export declare type BuildNpmResult = {
+    success: false;
+    reason: string;
+} | {
+    success: true;
+    reason: Record<string, any>;
+};
+export declare function buildNpm(options: {
+    projectPath: string;
+}): Promise<BuildNpmResult>;

package/dist/tt-ide-cli/src/features/open.d.ts

@@ -0,0 +1,3 @@
+export default function openProject(options: {
+    projectPath: string;
+}, remotePort?: number): Promise<void>;

package/dist/tt-ide-cli/src/features/packages.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Utils for microapp packages
+ */
+import type { ProjectConfig } from '@byted/miniprogram-utils/dist/data/project';
+import { ProjectSize } from '@byted/miniprogram-utils/typings/project';
+import archiver from 'archiver';
+import fg from 'fast-glob';
+/**
+ * 计算给定文件夹下面的文件体积总值
+ * @param folderPath directory path
+ * @param useTypeScript typescript
+ * @param options pass to fast-glob
+ * @returns
+ */
+export declare function getFolderSize(folderPath: string, useTypeScript: boolean, options?: fg.Options): Promise<number>;
+/**
+ * 以文件夹为单位的包体积统计，不适用于依赖分析
+ *
+ * @param projectConfig
+ * @param appJson
+ * @param projectPath
+ * @param isGame
+ */
+export declare function getProjectSize(projectConfig: ProjectConfig, appJson: any, projectPath: string, isGame: boolean): Promise<ProjectSize>;
+/**
+ * 校验当前项目的分包体积是否符合要求
+ * 若有错误，会抛出 promise 异常
+ *
+ * @param projectConfig
+ */
+export declare function verifySubPackageSize(projectConfig: ProjectConfig, type: 'preview' | 'upload'): Promise<void>;
+declare type FolderToZipStreamOption = {
+    whiteList: string[];
+    useTypeScript: boolean;
+};
+/**
+ * Convert a folder to zipStream. A new stream is created at each invocation.
+ *
+ * @param dir path to folder
+ */
+export declare function folderToZipStream(dir: string, { whiteList, useTypeScript }: FolderToZipStreamOption): Promise<archiver.Archiver>;
+/**
+ *
+ * @param dir path to microapp project
+ * @returns
+ */
+export declare function getProjectHash(dir: string): Promise<string>;
+/**
+ * For cli only
+ * @param input
+ */
+export declare function prettyProjectSize(input: ProjectSize): string;
+export {};

package/dist/tt-ide-cli/src/features/preview.d.ts

@@ -0,0 +1,80 @@
+import { ProjectConfig } from '@byted/miniprogram-utils/dist/data/project';
+import { ServerSize } from '@byted/miniprogram-utils/typings/project';
+import { ProjectInfo, QrcodeInfo } from '../types';
+import { IMetrics } from '../utils/metrics';
+import { IDEConfig, MakeSchemaOption } from '../utils/qrcode';
+export declare type ProjectQRCode = {
+    expireTime: number;
+    shortUrl: string;
+    originSchema: string;
+    qrcodeSVG?: string;
+    qrcodeFilePath?: string;
+    useCache: boolean;
+} & Pick<CompileProgressResult, 'metrics' | 'passJson'>;
+declare type CompileProgressResult = {
+    success: boolean;
+    /** error code */
+    error: number;
+    done: boolean;
+    msg: string;
+    metrics?: IMetrics;
+    errLink?: string;
+    passJson: {
+        packageSize?: ServerSize;
+    } & Record<string, any>;
+};
+export declare function checkProjectMatchAppid(projectConfig: ProjectConfig, appid?: string): Promise<void>;
+declare type PreviewOption = Pick<ProjectToQRCodeOption, 'project' | 'page' | 'qrcode' | 'cache' | 'copyToClipboard' | 'extraInfoJson' | 'localCompileVersion' | 'ideConfig' | 'interactGame'>;
+/**
+ * 预览上传（功能入口）
+ * @param options
+ * @returns
+ */
+export declare function preview(options: PreviewOption): Promise<ProjectQRCode>;
+declare type UploadOption = Pick<ProjectToQRCodeOption, 'project' | 'qrcode' | 'copyToClipboard' | 'extraInfoJson' | 'localCompileVersion' | 'ideConfig' | 'interactGame'> & {
+    version: string;
+    changeLog: string;
+    needUploadSourcemap?: boolean;
+};
+/**
+ * 发布上传（功能入口）
+ * @param options
+ * @returns
+ */
+export declare function upload(options: UploadOption): Promise<ProjectQRCode>;
+export declare type ProjectToQRCodeOption = {
+    project: ProjectInfo;
+    page: {
+        path: string;
+        query: string;
+        scene: string;
+        launchFrom: string;
+        location: string;
+    } & Pick<MakeSchemaOption, 'referrerInfo'>;
+    qrcode: QrcodeInfo;
+    cache: boolean;
+    copyToClipboard: boolean;
+    uploadOptions?: {
+        version: string;
+        changeLog: string;
+        needUploadSourcemap: boolean;
+    };
+    extraInfoJson?: string;
+    localCompileVersion?: string;
+    ideConfig?: IDEConfig;
+    debug?: {
+        query: {
+            gtoken: string;
+            roomid: string;
+            session: string;
+        };
+    };
+    uploadCache?: boolean;
+    interactGame?: {
+        extra: string;
+    };
+    supportSourcemap?: boolean;
+    enableHotRestartCache?: boolean;
+};
+export declare function projectToQRCode(options: ProjectToQRCodeOption): Promise<ProjectQRCode>;
+export {};

package/dist/tt-ide-cli/src/features/third-party.d.ts

@@ -0,0 +1,9 @@
+export declare enum INVALID_EXTAPP_REASON {
+    INVALID_APPID_META = 0,
+    INVALID_EXTAPPID = 1,
+    EXT_DISABLED = 2,
+    INVALID_EXT_JSON = 3,
+    INVALID_AUTH = 4,
+    NULL = 5
+}
+export declare const detectValidExtApp: any;

package/dist/tt-ide-cli/src/index.d.ts

@@ -0,0 +1,22 @@
+import { audit, getAuditHostsList } from './features/audit';
+import { getConfig, setConfig } from './features/config';
+import { createProject } from './features/create';
+import { checkSession, loginByEmail, loginByPhone, logout, sendVerificationCodeToPhone } from './features/login';
+import { getProjectSize, verifySubPackageSize } from './features/packages';
+import { checkProjectMatchAppid, ProjectToQRCodeOption, preview, ProjectQRCode, projectToQRCode, upload } from './features/preview';
+import { detectValidExtApp, INVALID_EXTAPP_REASON } from './features/third-party';
+import { ProjectInfo } from './types';
+import { setCookieFn } from './utils/cookie';
+import { IDEConfig, IDESandboxConfig, makeSchema, MakeSchemaOption, MakeSchemaResult } from './utils/qrcode';
+declare function open(options: {
+    project: ProjectInfo;
+    remotePort?: number;
+}): Promise<void>;
+declare function buildNpmFunc(options: {
+    project: ProjectInfo;
+}): Promise<import("./features/npm").BuildNpmResult>;
+export { ProjectQRCode, ProjectToQRCodeOption };
+export { open, setConfig, createProject as create, loginByEmail, loginByPhone, logout, sendVerificationCodeToPhone, checkSession, audit, getAuditHostsList, buildNpmFunc as buildNpm, preview, upload, projectToQRCode, setCookieFn, getConfig, detectValidExtApp, getProjectSize, verifySubPackageSize, checkProjectMatchAppid, INVALID_EXTAPP_REASON, IDEConfig, makeSchema, MakeSchemaOption, MakeSchemaResult, IDESandboxConfig, };
+export * from './features/meta';
+export * from './utils/metrics';
+export * as microgame from './features/microgame';

package/dist/tt-ide-cli/src/monitor/cli-monitor.d.ts

@@ -0,0 +1,15 @@
+interface CLIMonitorConfigOptions {
+    cliVersion: string;
+    cliName: string;
+}
+export declare class CliMonitor {
+    private static _instance;
+    private _didReportLaunch;
+    private readonly _commonParams;
+    private constructor();
+    static getInstance(config: CLIMonitorConfigOptions): CliMonitor;
+    shouldReport(eventName: string): boolean;
+    report(eventName: string, params?: Record<string, string | number | boolean>): void;
+    reportCommandCall(commandName: string): void;
+}
+export {};

package/dist/tt-ide-cli/src/monitor/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const CLI_EVENTS: {
+    IDE_CLI_LAUNCH: string;
+    IDE_CLI_COMMAND_CALL: string;
+    IDE_CLI_PREVIEW_FAIL: string;
+    IDE_CLI_UPLOAD_FAIL: string;
+    IDE_CLI_ERROR: string;
+};

package/dist/tt-ide-cli/src/monitor/index.d.ts

@@ -0,0 +1,2 @@
+export { CliMonitor } from './cli-monitor';
+export { CLI_EVENTS } from './constants';

package/dist/tt-ide-cli/src/types.d.ts

@@ -0,0 +1,44 @@
+export interface ProjectInfo {
+    path: string;
+}
+export interface TMACliConfig {
+    proxy: string | null;
+    tempFilePath: string | null;
+    storagePath: string;
+    url: {
+        makeSchema: string;
+        compileProgress: string;
+        preview: string;
+        upload: string;
+        emailLogin: string;
+        mobileLogin: string;
+        sendLoginCode: string;
+        getUserInfo: string;
+    };
+    interactGameUrl: {
+        makeSchema: string;
+        compileProgress: string;
+        preview: string;
+        upload: string;
+    };
+    microgameUrl: {
+        makeSchema: string;
+        compileProgress: string;
+        preview: string;
+        upload: string;
+        versionInfo: string;
+    };
+    env: {
+        type: 'online' | 'ppe' | 'boe';
+        channel: string;
+    };
+    allowReportEvent: boolean;
+}
+export interface QrcodeInfo {
+    format: 'imageFile' | 'terminal' | 'imageSVG' | 'plain' | null;
+    output?: string;
+    options?: {
+        small?: boolean;
+    };
+}
+export {};

package/dist/tt-ide-cli/src/utils/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const IDE_SCHEMA = "bytedanceide:";
+export declare const TEMPLATE_DOWNLOAD_URL = "https://sf1-cdn-tos.douyinstatic.com/obj/microapp/frontend/ide/template/tma-demo-master.zip";
+export declare const TS_TEMPLATE_DOWNLOAD_URL = "https://sf1-cdn-tos.douyinstatic.com/obj/microapp/frontend/ide/template/tma-demo-master-ts.zip";

package/dist/tt-ide-cli/src/utils/cookie.d.ts

@@ -0,0 +1,6 @@
+declare type GetCookieFunction = () => Promise<string>;
+export declare let getUserCookies: GetCookieFunction;
+export declare function saveUserCookies(cookies: string[]): void;
+export declare function removeUserCookies(): void;
+export declare function setCookieFn(fn: GetCookieFunction): void;
+export {};

package/dist/tt-ide-cli/src/utils/logger.d.ts

@@ -0,0 +1,19 @@
+import ora from 'ora';
+declare abstract class BaseLogger {
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    loading(text: string): Pick<ora.Ora, 'text' | 'color' | 'stop'>;
+    stopLoading(): void;
+}
+declare class Logger extends BaseLogger {
+}
+declare class CliLogger extends BaseLogger {
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    loading(text: string): ora.Ora;
+    stopLoading(): void;
+}
+declare const logger: Logger | CliLogger;
+export default logger;

package/dist/tt-ide-cli/src/utils/metrics.d.ts

@@ -0,0 +1,67 @@
+export interface IMetrics {
+    nodes?: Array<{
+        node: string;
+        timestamp: number;
+    }>;
+    compiler?: string;
+    compilerVersion?: string;
+    [key: string]: any;
+}
+/**
+ * Push event node to metrics.
+ *
+ * Side-effected, shall mutate the `nodes` field in `metrics` object.
+ * @param metrics
+ * @param event
+ */
+export declare function addNodeToMetrics(metrics: IMetrics, event: string): void;
+/**
+ * Add field with to metrics.
+ *
+ * Side-effected, shall mutate the `metrics` object.
+ * @param metrics
+ * @param field
+ * @param value
+ */
+export declare function addFieldToMetrics(metrics: IMetrics, field: string, value: any): void;
+/**
+ * Merge a list of metrics, return a new metric.
+ *
+ * Non-side-effected.
+ * @param metrics
+ * @returns
+ */
+export declare function mergeMetrics(...metrics: IMetrics[]): IMetrics;
+/**
+ * Abstract for {@link IMetrics}
+ */
+export declare class Metrics {
+    nodes: IMetrics['nodes'];
+    tags: Exclude<IMetrics, 'nodes'>;
+    /**
+     * Add node to {@link nodes}
+     * @param event
+     * @param timestamp
+     */
+    addNode(event: string, timestamp?: number): this;
+    /**
+     * Add node to {@link tags}
+     * @param field
+     * @param value
+     */
+    updateField(field: string, value: keyof Exclude<IMetrics, 'nodes'>): this;
+    /**
+     * Merge metrics, the order matters
+     */
+    merge(...others: IMetrics[]): this;
+    /**
+     * Settle the metrics
+     * @param clear whether to reset the metrics to empty.
+     * @returns
+     */
+    settle(clear?: boolean): IMetrics;
+    /**
+     * Clear the metrics.
+     */
+    clear(): this;
+}

package/dist/tt-ide-cli/src/utils/qrcode.d.ts

@@ -0,0 +1,64 @@
+export interface MakeSchemaResult {
+    originSchema: string;
+    shortUrl: string;
+    expireTime: number;
+}
+interface RoomInfo {
+    gtoken: string;
+    roomid: string;
+}
+interface QRCodeQuery extends RoomInfo {
+    [k: string]: string;
+}
+interface BDPLog {
+    launch_from: string;
+    location: string;
+}
+export declare type IDEConfig = IDEBaseConfig & IDESandboxConfig;
+export interface IDEBaseConfig {
+    previewScene: 'live' | 'default';
+    ideVersion: string;
+    ideOS: string;
+    ideDid: string;
+    ideUid: number;
+    skipDomainCheck?: boolean;
+    inspectPlatform?: DevicePlatform;
+    iOSDebugVersion?: string;
+    connectType?: 'push' | 'scan';
+}
+export interface IDESandboxConfig {
+    isSandbox?: boolean;
+    randomKey?: string;
+    accountName?: string;
+    appId?: string;
+    appName?: string;
+    expireTime?: string;
+}
+declare type DevicePlatform = 'Android' | 'iOS' | 'all';
+export declare type MakeSchemaOption = {
+    devAppid: string;
+    extAppid: string;
+    startPage: string;
+    query: string;
+    qrcodeQuery?: QRCodeQuery;
+    scene: string;
+    bdpLog: BDPLog;
+    headers: object;
+    inspectPlatform?: DevicePlatform;
+    ideConfig?: IDEConfig;
+    referrerInfo?: {
+        appId: string;
+        extraData: Record<string, unknown>;
+    };
+    isInteractGame?: boolean;
+    hotRestartHash?: string;
+    type: string;
+};
+export declare function makeSchema(options: MakeSchemaOption): Promise<MakeSchemaResult>;
+export declare function toQRCodeSVG(str: string): Promise<string>;
+export declare function toQRCodeFile(text: string, filePath: string): Promise<any>;
+export declare function generateTerminalQrCode(url: string, options: {
+    small?: boolean;
+    copy?: boolean;
+}): void;
+export {};