@oiyo/core 0.3.0 → 0.3.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 /**
- * @oiyo/core v0.3.0
+ * @oiyo/core v0.3.1
  * Copyright (c) 2026 skiyee. All rights reserved.
  * Commercial software. See LICENSE for terms.
  * Official site: https://oiyo.js.org
@@ -43,17 +43,11 @@ declare function createLogger(level?: LogLevel, options?: LoggerOptions): Logger
 //#endregion
 //#region src/module/api/types.d.ts
 interface ApiFile {
-  /** 源文件在磁盘上的绝对路径 */
   filePath: string;
-  /** 导出名称，如 'default' 或具名导出 */
   exportName: string;
-  /** 被消费的导入绝对路径 */
   importPath: string;
-  /** 被消费的引用命名 */
   importName: string;
-  /** 是否为类型 */
   isType: boolean;
-  /** 是否位于 Node 模块中 */
   isNodeModule: boolean;
 }
 //#endregion
@@ -98,7 +92,6 @@ declare class OiyoModApi {
   private readonly config;
   private readonly logger;
   private readonly oiyoState;
-  /** 不含有 only 的 ApiScanTarget */
   private sources;
   apis: Map<string, ApiFile>;
   constructor(config: OiyoConfig, deps: {
@@ -112,19 +105,7 @@ declare class OiyoModApi {
   private recordApiSource;
   private toApiSource;
   private saveApi;
-  /**
-   * 直接提取
-   * - 1.必须是 Node 包
-   * - 2.必须指定某些值
-   */
   private directApi;
-  /**
-   * 扫描提取
-   * - 纯文件
-   * - 路径
-   * - node包
-   * - glob语法
-   */
   private scanApi;
   scanApis(): Promise<(ApiFile[] | void[] | undefined)[]>;
   private findApiSource;
@@ -141,37 +122,19 @@ declare class OiyoModApi {
 //#endregion
 //#region src/module/component/types.d.ts
 interface ComponentFile {
-  /** 源文件在磁盘上的绝对路径 */
   filePath: string;
-  /** 导出名称，如 'default' 或具名导出 */
   exportName: string;
-  /** 被消费的引用命名 */
   importName: string;
-  /** 被消费的导入绝对路径 */
   importPath: string;
-  /** 是否位于 Node 模块中 */
   isNodeModule: boolean;
 }
 interface ComponentScanSource extends ComponentScanTarget {
-  /**
-   * 扫描真实绝对路径
-   */
   dir: string;
-  /**
-   * 匹配文件模式 (支持glob语法)
-   */
   patterns?: string[];
-  /**
-   * 包的导出接口，用于针对 Node module
-   */
   isNodeModule: boolean;
 }
 //#endregion
 //#region src/module/component/instance.d.ts
-/**
- * TODO:
- * - 当 config 中含多个相同(范围匹配)的 target 时合并他们。
- */
 declare class OiyoModComponent {
   private readonly config;
   private readonly logger;
@@ -191,17 +154,7 @@ declare class OiyoModComponent {
   private recordComponentSource;
   private toComponentSource;
   private saveComponent;
-  /**
-   * 直接提取
-   * - 1.必须是 Node 包
-   * - 2.必须指定某些值
-   */
   private scanComponentByDirect;
-  /**
-   * 扫描提取
-   * - 1.可以是 路径、 Node 包
-   * - 2.不能指定某些值
-   */
   private scanComponentByDir;
   private scanComponent;
   scanComponents(): Promise<void>;
@@ -212,7 +165,7 @@ declare class OiyoModComponent {
   generateDeclaration(): string;
   writeDeclaration(): void;
   applyComponents(source: string, file: string, options?: {
-    /** 同时应用Api */withApis: boolean;
+    withApis: boolean;
   }): {
     code: string;
     map: _$magic_string0.SourceMap;
@@ -220,15 +173,9 @@ declare class OiyoModComponent {
 }
 //#endregion
 //#region src/module/layout/types.d.ts
-/**
- * 布局信息
- */
 interface LayoutFile {
-  /** 布局应用名称 */
   useName: string;
-  /** 布局组件名称 */
   componentName: string;
-  /** 布局文件的绝对路径 */
   filePath: string;
 }
 //#endregion
@@ -277,7 +224,6 @@ declare class OiyoModRoot {
   rootTemplateScript: string;
   rootMarcoImports: Map<string, ImportInfo>;
   rootMarcoScript: string;
-  /** 根虚拟模块 */
   rootVM?: string;
   constructor(config: OiyoConfig, deps: {
     logger: Logger;
@@ -295,15 +241,7 @@ declare class OiyoModRoot {
 }
 //#endregion
 //#region src/module/root/macro.d.ts
-/**
- * 根上下文工厂函数
- */
 type RootContextFactory<T extends object> = () => T;
-/**
- * 定义根上下文
- * @param factory 返回上下文对象的工厂函数
- * @returns 上下文对象
- */
 declare const defineRootContext: <T extends object>(factory: RootContextFactory<T>) => T;
 //#endregion
 //#region src/module/root/virtual-module.d.ts
@@ -311,44 +249,20 @@ declare const VIRTUAL_ROOT_CONTEXT_ID = "virtual:oiyo-root-context";
 declare const RESOLVED_VIRTUAL_ROOT_CONTEXT_ID = "\0virtual:oiyo-root-context";
 //#endregion
 //#region src/module/route/types.d.ts
-/**
- * 可序列化的页面元信息值类型
- * 用于静态提取和 pages.json 生成
- */
 type PageMetaValue = string | number | boolean | null | PageMetaObject | PageMetaValue[];
-/**
- * 可序列化的页面元信息对象
- */
 interface PageMetaObject {
   [key: string]: PageMetaValue | undefined;
 }
-/**
- * 页面元信息基础字段
- */
 interface BasePageMeta {
-  /** 页面类型 */
   type?: 'page' | 'home';
-  /** 使用的布局名称，false 表示不使用布局 */
   layout?: string | false;
-  /** uni-app 页面样式配置 */
   style?: GlobalStyle;
 }
-/**
- * 已解析的页面元信息
- * 用于编译期静态提取和 pages.json 生成
- */
 interface ResolvedPageMeta extends BasePageMeta, PageMetaObject {}
-/**
- * 页面文件信息
- */
 interface PageFile {
-  /** 页面路径（相对于 srcDir，不含扩展名） */
   pagePath: string;
-  /** 页面文件的绝对路径 */
   filePath: string;
-  /** 页面元信息 */
   pageMeta: ResolvedPageMeta;
-  /** 所属包（main 或子包名称） */
   pageBelong: string;
 }
 //#endregion
@@ -403,19 +317,9 @@ declare class OiyoModRoute {
 }
 //#endregion
 //#region src/module/route/macro.d.ts
-/**
- * 页面元信息
- * 用户在 definePageMeta() 中使用的类型
- * 支持通过 declare module '@skiyee/oiyo' 进行扩展
- */
 interface PageMeta extends BasePageMeta {
-  /** 其他自定义字段 */
   [key: string]: unknown;
 }
-/**
- * 定义页面元信息
- * @param meta 页面元信息配置
- */
 declare const definePageMeta: (meta: PageMeta) => void;
 //#endregion
 //#region src/module/route/placeholder.d.ts

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 /**
- * @oiyo/core v0.3.0
+ * @oiyo/core v0.3.1
  * Copyright (c) 2026 skiyee. All rights reserved.
  * Commercial software. See LICENSE for terms.
  * Official site: https://oiyo.js.org
@@ -43,17 +43,11 @@ declare function createLogger(level?: LogLevel, options?: LoggerOptions): Logger
 //#endregion
 //#region src/module/api/types.d.ts
 interface ApiFile {
-  /** 源文件在磁盘上的绝对路径 */
   filePath: string;
-  /** 导出名称，如 'default' 或具名导出 */
   exportName: string;
-  /** 被消费的导入绝对路径 */
   importPath: string;
-  /** 被消费的引用命名 */
   importName: string;
-  /** 是否为类型 */
   isType: boolean;
-  /** 是否位于 Node 模块中 */
   isNodeModule: boolean;
 }
 //#endregion
@@ -98,7 +92,6 @@ declare class OiyoModApi {
   private readonly config;
   private readonly logger;
   private readonly oiyoState;
-  /** 不含有 only 的 ApiScanTarget */
   private sources;
   apis: Map<string, ApiFile>;
   constructor(config: OiyoConfig, deps: {
@@ -112,19 +105,7 @@ declare class OiyoModApi {
   private recordApiSource;
   private toApiSource;
   private saveApi;
-  /**
-   * 直接提取
-   * - 1.必须是 Node 包
-   * - 2.必须指定某些值
-   */
   private directApi;
-  /**
-   * 扫描提取
-   * - 纯文件
-   * - 路径
-   * - node包
-   * - glob语法
-   */
   private scanApi;
   scanApis(): Promise<(ApiFile[] | void[] | undefined)[]>;
   private findApiSource;
@@ -141,37 +122,19 @@ declare class OiyoModApi {
 //#endregion
 //#region src/module/component/types.d.ts
 interface ComponentFile {
-  /** 源文件在磁盘上的绝对路径 */
   filePath: string;
-  /** 导出名称，如 'default' 或具名导出 */
   exportName: string;
-  /** 被消费的引用命名 */
   importName: string;
-  /** 被消费的导入绝对路径 */
   importPath: string;
-  /** 是否位于 Node 模块中 */
   isNodeModule: boolean;
 }
 interface ComponentScanSource extends ComponentScanTarget {
-  /**
-   * 扫描真实绝对路径
-   */
   dir: string;
-  /**
-   * 匹配文件模式 (支持glob语法)
-   */
   patterns?: string[];
-  /**
-   * 包的导出接口，用于针对 Node module
-   */
   isNodeModule: boolean;
 }
 //#endregion
 //#region src/module/component/instance.d.ts
-/**
- * TODO:
- * - 当 config 中含多个相同(范围匹配)的 target 时合并他们。
- */
 declare class OiyoModComponent {
   private readonly config;
   private readonly logger;
@@ -191,17 +154,7 @@ declare class OiyoModComponent {
   private recordComponentSource;
   private toComponentSource;
   private saveComponent;
-  /**
-   * 直接提取
-   * - 1.必须是 Node 包
-   * - 2.必须指定某些值
-   */
   private scanComponentByDirect;
-  /**
-   * 扫描提取
-   * - 1.可以是 路径、 Node 包
-   * - 2.不能指定某些值
-   */
   private scanComponentByDir;
   private scanComponent;
   scanComponents(): Promise<void>;
@@ -212,7 +165,7 @@ declare class OiyoModComponent {
   generateDeclaration(): string;
   writeDeclaration(): void;
   applyComponents(source: string, file: string, options?: {
-    /** 同时应用Api */withApis: boolean;
+    withApis: boolean;
   }): {
     code: string;
     map: _$magic_string0.SourceMap;
@@ -220,15 +173,9 @@ declare class OiyoModComponent {
 }
 //#endregion
 //#region src/module/layout/types.d.ts
-/**
- * 布局信息
- */
 interface LayoutFile {
-  /** 布局应用名称 */
   useName: string;
-  /** 布局组件名称 */
   componentName: string;
-  /** 布局文件的绝对路径 */
   filePath: string;
 }
 //#endregion
@@ -277,7 +224,6 @@ declare class OiyoModRoot {
   rootTemplateScript: string;
   rootMarcoImports: Map<string, ImportInfo>;
   rootMarcoScript: string;
-  /** 根虚拟模块 */
   rootVM?: string;
   constructor(config: OiyoConfig, deps: {
     logger: Logger;
@@ -295,15 +241,7 @@ declare class OiyoModRoot {
 }
 //#endregion
 //#region src/module/root/macro.d.ts
-/**
- * 根上下文工厂函数
- */
 type RootContextFactory<T extends object> = () => T;
-/**
- * 定义根上下文
- * @param factory 返回上下文对象的工厂函数
- * @returns 上下文对象
- */
 declare const defineRootContext: <T extends object>(factory: RootContextFactory<T>) => T;
 //#endregion
 //#region src/module/root/virtual-module.d.ts
@@ -311,44 +249,20 @@ declare const VIRTUAL_ROOT_CONTEXT_ID = "virtual:oiyo-root-context";
 declare const RESOLVED_VIRTUAL_ROOT_CONTEXT_ID = "\0virtual:oiyo-root-context";
 //#endregion
 //#region src/module/route/types.d.ts
-/**
- * 可序列化的页面元信息值类型
- * 用于静态提取和 pages.json 生成
- */
 type PageMetaValue = string | number | boolean | null | PageMetaObject | PageMetaValue[];
-/**
- * 可序列化的页面元信息对象
- */
 interface PageMetaObject {
   [key: string]: PageMetaValue | undefined;
 }
-/**
- * 页面元信息基础字段
- */
 interface BasePageMeta {
-  /** 页面类型 */
   type?: 'page' | 'home';
-  /** 使用的布局名称，false 表示不使用布局 */
   layout?: string | false;
-  /** uni-app 页面样式配置 */
   style?: GlobalStyle;
 }
-/**
- * 已解析的页面元信息
- * 用于编译期静态提取和 pages.json 生成
- */
 interface ResolvedPageMeta extends BasePageMeta, PageMetaObject {}
-/**
- * 页面文件信息
- */
 interface PageFile {
-  /** 页面路径（相对于 srcDir，不含扩展名） */
   pagePath: string;
-  /** 页面文件的绝对路径 */
   filePath: string;
-  /** 页面元信息 */
   pageMeta: ResolvedPageMeta;
-  /** 所属包（main 或子包名称） */
   pageBelong: string;
 }
 //#endregion
@@ -403,19 +317,9 @@ declare class OiyoModRoute {
 }
 //#endregion
 //#region src/module/route/macro.d.ts
-/**
- * 页面元信息
- * 用户在 definePageMeta() 中使用的类型
- * 支持通过 declare module '@skiyee/oiyo' 进行扩展
- */
 interface PageMeta extends BasePageMeta {
-  /** 其他自定义字段 */
   [key: string]: unknown;
 }
-/**
- * 定义页面元信息
- * @param meta 页面元信息配置
- */
 declare const definePageMeta: (meta: PageMeta) => void;
 //#endregion
 //#region src/module/route/placeholder.d.ts