@weapp-core/schematics 6.0.0 → 6.0.2

package/dist/index.d.cts

@@ -0,0 +1,457 @@
+/**
+ * @description 生成模板的目标类型
+ */
+type GenerateType = 'app' | 'page' | 'component';
+/**
+ * @description JSON 输出扩展名
+ */
+type JsonExt = 'json' | 'js' | 'ts' | (string & {});
+
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * 全局配置, 小程序根目录下的 app.json 文件用来对微信小程序进行全局配置。
+ */
+interface App$1 {
+    appBar?: {
+        [k: string]: unknown;
+    };
+    componentFramework?: string;
+    convertRpxToVw?: boolean;
+    darkmode?: boolean;
+    debug?: boolean;
+    debugOptions?: {
+        [k: string]: unknown;
+    };
+    embeddedAppIdList?: string[];
+    enablePassiveEvent?: {
+        [k: string]: unknown;
+    } | boolean;
+    entranceDeclare?: {
+        [k: string]: unknown;
+    };
+    /**
+     * 指定小程序的默认启动路径（首页），常见情景是从微信聊天列表页下拉启动、小程序列表启动等。如果不填，将默认为 pages 列表的第一项。不支持带页面路径参数。
+     */
+    entryPagePath?: string;
+    functionalPages?: boolean;
+    halfPage?: {
+        [k: string]: unknown;
+    };
+    lazyCodeLoading?: string;
+    miniApp?: {
+        [k: string]: unknown;
+    };
+    networkTimeout?: {
+        connectSocket?: number;
+        downloadFile?: number;
+        request?: number;
+        uploadFile?: number;
+        [k: string]: unknown;
+    };
+    /**
+     * 用于指定小程序由哪些页面组成，每一项都对应一个页面的 路径（含文件名） 信息。文件名不需要写文件后缀，框架会自动去寻找对应位置的 .json, .js, .wxml, .wxss 四个文件进行处理。
+     */
+    pages: string[];
+    permission?: {
+        [k: string]: unknown;
+    };
+    plugins?: {
+        [k: string]: unknown;
+    };
+    preloadRule?: {
+        [k: string]: unknown;
+    };
+    renderer?: "webview" | "skyline";
+    rendererOptions?: {
+        skyline?: {
+            defaultContentBox?: boolean;
+            defaultDisplayBlock?: boolean;
+            disableABTest?: boolean;
+            [k: string]: unknown;
+        };
+        [k: string]: unknown;
+    };
+    requiredBackgroundModes?: string[];
+    requiredPrivateInfos?: string[];
+    resizable?: boolean;
+    resolveAlias?: {
+        [k: string]: unknown;
+    };
+    serviceProviderTicket?: string;
+    singlePage?: {
+        [k: string]: unknown;
+    };
+    sitemapLocation?: string;
+    static?: {
+        [k: string]: unknown;
+    };
+    style?: string;
+    subPackages?: {
+        entry?: string;
+        independent?: boolean;
+        name?: string;
+        pages?: string[];
+        root?: string;
+        [k: string]: unknown;
+    }[];
+    subpackages?: {
+        entry?: string;
+        independent?: boolean;
+        name?: string;
+        pages?: string[];
+        root?: string;
+        [k: string]: unknown;
+    }[];
+    supportedMaterials?: {
+        [k: string]: unknown;
+    };
+    tabBar?: {
+        backgroundColor: string;
+        borderStyle?: "black" | "white";
+        color: string;
+        custom?: boolean;
+        /**
+         * @minItems 2
+         * @maxItems 5
+         */
+        list: [
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            }
+        ] | [
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            }
+        ] | [
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            }
+        ] | [
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            },
+            {
+                iconPath?: string;
+                pagePath: string;
+                selectedIconPath?: string;
+                text: string;
+                [k: string]: unknown;
+            }
+        ];
+        position?: "bottom" | "top";
+        selectedColor: string;
+        [k: string]: unknown;
+    };
+    themeLocation?: string;
+    useExtendedLib?: {
+        [k: string]: unknown;
+    };
+    usingComponents?: {
+        [k: string]: string;
+    };
+    window?: {
+        backgroundColor?: string;
+        backgroundColorBottom?: string;
+        backgroundColorTop?: string;
+        backgroundTextStyle?: "dark" | "light";
+        enablePullDownRefresh?: boolean;
+        handleWebviewPreload?: "static" | "manual" | "auto";
+        homeButton?: boolean;
+        initialRenderingCache?: "static" | "dynamic";
+        navigationBarBackgroundColor?: string;
+        navigationBarTextStyle?: string;
+        navigationBarTitleText?: string;
+        navigationStyle?: "default" | "custom";
+        onReachBottomDistance?: number;
+        pageOrientation?: "portrait" | "auto" | "landscape";
+        restartStrategy?: "homePage" | "homePageAndLatestPage";
+        visualEffectInBackground?: "none" | "hidden";
+        [k: string]: unknown;
+    };
+    workers?: string | {
+        isSubpackage?: boolean;
+        path?: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * 自定义组件配置
+ */
+interface Component$1 {
+    component?: boolean;
+    componentFramework?: string;
+    componentGenerics?: {
+        [k: string]: unknown;
+    };
+    componentPlaceholder?: {
+        [k: string]: unknown;
+    };
+    styleIsolation?: "isolated" | "apply-shared" | "shared";
+    usingComponents?: {
+        [k: string]: string;
+    };
+    [k: string]: unknown;
+}
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * 页面配置, 支持对单个页面进行配置，可以在页面对应的 .json 文件来对本页面的表现进行配置
+ */
+interface Page$1 {
+    backgroundColor?: string;
+    backgroundColorBottom?: string;
+    backgroundColorContent?: string;
+    backgroundColorTop?: string;
+    backgroundTextStyle?: "dark" | "light";
+    componentFramework?: string;
+    componentPlaceholder?: {
+        [k: string]: unknown;
+    };
+    disableScroll?: boolean;
+    enablePassiveEvent?: {
+        [k: string]: unknown;
+    } | boolean;
+    enablePullDownRefresh?: boolean;
+    handleWebviewPreload?: "static" | "manual" | "auto";
+    homeButton?: boolean;
+    initialRenderingCache?: "static" | "dynamic";
+    navigationBarBackgroundColor?: string;
+    navigationBarTextStyle?: string;
+    navigationBarTitleText?: string;
+    navigationStyle?: "default" | "custom";
+    onReachBottomDistance?: number;
+    pageOrientation?: "portrait" | "auto" | "landscape";
+    renderer?: "webview" | "skyline";
+    rendererOptions?: {
+        skyline?: {
+            defaultContentBox?: boolean;
+            defaultDisplayBlock?: boolean;
+            disableABTest?: boolean;
+            [k: string]: unknown;
+        };
+        [k: string]: unknown;
+    };
+    restartStrategy?: "homePage" | "homePageAndLatestPage";
+    singlePage?: {
+        [k: string]: unknown;
+    };
+    style?: string;
+    styleIsolation?: "page-isolated" | "page-apply-shared" | "page-shared";
+    usingComponents?: {
+        [k: string]: string;
+    };
+    visualEffectInBackground?: "none" | "hidden";
+    [k: string]: unknown;
+}
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/sitemap.html
+ */
+interface Sitemap$1 {
+    rules: {
+        action?: "allow" | "disallow";
+        matching?: "exact" | "inclusive" | "exclusive" | "partial";
+        page: string;
+        params?: string[];
+        priority?: number;
+    }[];
+    [k: string]: unknown;
+}
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+interface Theme$1 {
+    dark: {
+        [k: string]: unknown;
+    };
+    light: {
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/development.html#%E6%8F%92%E4%BB%B6%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6
+ */
+interface Plugin$1 {
+    main?: string;
+    pages?: {
+        [k: string]: string;
+    };
+    publicComponents?: {
+        [k: string]: string;
+    };
+    [k: string]: unknown;
+}
+
+/**
+ * @description app.json 类型定义
+ */
+type App = App$1;
+/**
+ * @description component.json 类型定义
+ */
+type Component = Component$1;
+/**
+ * @description page.json 类型定义
+ */
+type Page = Page$1;
+/**
+ * @description sitemap.json 类型定义
+ */
+type Sitemap = Sitemap$1;
+/**
+ * @description theme.json 类型定义
+ */
+type Theme = Theme$1;
+/**
+ * @description plugin.json 类型定义
+ */
+type Plugin = Plugin$1;
+
+declare const JSON_SCHEMA_DEFINITIONS: readonly [{
+    filename: "app.json";
+    typeName: "App";
+    schema: unknown;
+}, {
+    filename: "component.json";
+    typeName: "Component";
+    schema: unknown;
+}, {
+    filename: "page.json";
+    typeName: "Page";
+    schema: unknown;
+}, {
+    filename: "sitemap.json";
+    typeName: "Sitemap";
+    schema: unknown;
+}, {
+    filename: "theme.json";
+    typeName: "Theme";
+    schema: unknown;
+}, {
+    filename: "plugin.json";
+    typeName: "Plugin";
+    schema: unknown;
+}];
+
+/**
+ * @description 生成 JS 模板（app/page/component）
+ */
+declare function generateJs(type?: GenerateType): "App({})" | "Page({})" | "Component({})";
+/**
+ * @description 生成 WXSS 模板
+ */
+declare function generateWxss(): string;
+/**
+ * @description 生成 WXML 模板
+ */
+declare function generateWxml(filepath?: string): string;
+/**
+ * @description 生成 JSON/JS/TS 模板
+ */
+declare function generateJson(type?: GenerateType, ext?: JsonExt): string;
+
+export { type App, type Component, type GenerateType, JSON_SCHEMA_DEFINITIONS, type Page, type Plugin, type Sitemap, type Theme, generateJs, generateJson, generateWxml, generateWxss };

package/dist/index.d.ts

@@ -1,4 +1,10 @@
+/**
+ * @description 生成模板的目标类型
+ */
 type GenerateType = 'app' | 'page' | 'component';
+/**
+ * @description JSON 输出扩展名
+ */
 type JsonExt = 'json' | 'js' | 'ts' | (string & {});
 
 /**
@@ -380,11 +386,29 @@ interface Plugin$1 {
     [k: string]: unknown;
 }
 
+/**
+ * @description app.json 类型定义
+ */
 type App = App$1;
+/**
+ * @description component.json 类型定义
+ */
 type Component = Component$1;
+/**
+ * @description page.json 类型定义
+ */
 type Page = Page$1;
+/**
+ * @description sitemap.json 类型定义
+ */
 type Sitemap = Sitemap$1;
+/**
+ * @description theme.json 类型定义
+ */
 type Theme = Theme$1;
+/**
+ * @description plugin.json 类型定义
+ */
 type Plugin = Plugin$1;
 
 declare const JSON_SCHEMA_DEFINITIONS: readonly [{
@@ -413,9 +437,21 @@ declare const JSON_SCHEMA_DEFINITIONS: readonly [{
     schema: unknown;
 }];
 
+/**
+ * @description 生成 JS 模板（app/page/component）
+ */
 declare function generateJs(type?: GenerateType): "App({})" | "Page({})" | "Component({})";
+/**
+ * @description 生成 WXSS 模板
+ */
 declare function generateWxss(): string;
+/**
+ * @description 生成 WXML 模板
+ */
 declare function generateWxml(filepath?: string): string;
+/**
+ * @description 生成 JSON/JS/TS 模板
+ */
 declare function generateJson(type?: GenerateType, ext?: JsonExt): string;
 
 export { type App, type Component, type GenerateType, JSON_SCHEMA_DEFINITIONS, type Page, type Plugin, type Sitemap, type Theme, generateJs, generateJson, generateWxml, generateWxss };