@zwa73/utils 1.0.278 → 1.0.279

package/dist/Constant.d.ts

@@ -0,0 +1,9 @@
+type ImportOptionPackOpt = {
+    /**包名 */
+    name: string;
+    /**安装指令提示 */
+    installTip: string;
+};
+/**导入可选包 */
+export declare function importOptionPack<T>(opt: ImportOptionPackOpt): Promise<T>;
+export {};

package/dist/Constant.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.importOptionPack = importOptionPack;
+const UtilFunctions_1 = require("./UtilFunctions");
+/**导入可选包 */
+async function importOptionPack(opt) {
+    const { name, installTip } = opt;
+    const pack = await UtilFunctions_1.UtilFunc.dynamicImport(name);
+    if (pack == undefined)
+        UtilFunctions_1.UtilFunc.throwError(`npm包 ${name} 动态导入失败, 可能是未安装, 可使用 ${installTip} 安装`);
+    return pack;
+}

package/dist/UtilClass/Hbs.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Hbs = void 0;
-const js_utils_1 = require("@zwa73/js-utils");
-const UtilFunctions_1 = require("../UtilFunctions");
+const Constant_1 = require("../Constant");
 const UtilLogger_1 = require("../UtilLogger");
 /**文本模板渲染器
  * @template T - 上下文对象的类型，默认为记录类型
@@ -35,9 +34,10 @@ class Hbs {
      * @param context - 上下文对象，用于在渲染模板时提供数据
      */
     static async create(context = {}) {
-        const Handlebars = await js_utils_1.JsFunc.dynamicImport('handlebars');
-        if (Handlebars == undefined)
-            UtilFunctions_1.UtilFunc.throwError(`npm包 handlebars 动态导入失败, 此包不会随@zwa73/utils自动安装, 可能是未安装, 可使用 npm i handlebars@4.7.8 来安装`);
+        const Handlebars = await (0, Constant_1.importOptionPack)({
+            name: 'handlebars',
+            installTip: 'npm i handlebars@4.7.8'
+        });
         //console.log(Handlebars);
         const hbs = Handlebars.create();
         return new Hbs(hbs, context);

package/dist/UtilClass/Markdown.d.ts

@@ -4,7 +4,13 @@ type ExtractBlockOpt = {
     /**要提取的标题 必须为 "# 标题" 的格式 */
     title: string;
     /**将标题从结构中排除 */
-    trimTitle: boolean;
+    trimTitle?: boolean;
+};
+type ExtractCodeBlockOpt = {
+    /**要提取的标题 必须为 "# 标题" 的格式 */
+    title: string;
+    /**代码类型标记 为undefined时匹配任意 */
+    codetype?: string;
 };
 type FromArg = {
     data?: Record<string, any>;
@@ -40,5 +46,10 @@ export declare class Markdown<D extends Record<string, any> = Record<string, any
      * @param opt - 选项
      */
     extractJson(title: string): string | undefined;
+    /**根据标题提取块内第一个代码块
+     * @param title    - 标题
+     * @param codetype - 代码类型
+     */
+    extractCodeBlock(opt: ExtractCodeBlockOpt): string | undefined;
 }
 export {};

package/dist/UtilClass/Markdown.js

@@ -5,21 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Markdown = void 0;
 const fs_1 = __importDefault(require("fs"));
-const js_utils_1 = require("@zwa73/js-utils");
-const UtilFunctions_1 = require("../UtilFunctions");
+const Constant_1 = require("../Constant");
 const UtilLogger_1 = require("../UtilLogger");
-const getMatter = async () => {
-    const matter = await js_utils_1.JsFunc.dynamicImport('gray-matter');
-    if (matter == undefined)
-        js_utils_1.JsFunc.throwError(`npm包 gray-matter 动态导入失败, 此包不会随@zwa73/utils自动安装, 可能是未安装, 可使用 npm i gray-matter@4.0.3 来安装`);
-    return matter;
-};
-const getYaml = async () => {
-    const yaml = await UtilFunctions_1.UtilFunc.dynamicImport('yaml');
-    if (yaml == undefined)
-        UtilFunctions_1.UtilFunc.throwError(`npm包 yaml 动态导入失败, 此包不会随@zwa73/utils自动安装, 可能是未安装, 可使用 npm i yaml@2.8.1 来安装`);
-    return yaml;
-};
+const getMatter = async () => await (0, Constant_1.importOptionPack)({
+    name: 'gray-matter',
+    installTip: 'npm i gray-matter@4.0.3'
+});
+const getYaml = async () => await (0, Constant_1.importOptionPack)({
+    name: 'yaml',
+    installTip: 'npm i yaml@2.8.1'
+});
 /**Markdown解析器 */
 class Markdown {
     data;
@@ -105,7 +100,21 @@ class Markdown {
      * @param opt - 选项
      */
     extractJson(title) {
-        return this.extractBlock({ title, trimTitle: true })?.trim().replace(/```json\n([\s\S]+)\n```/, '$1');
+        return this.extractCodeBlock({ title, codetype: 'json' });
+    }
+    /**根据标题提取块内第一个代码块
+     * @param title    - 标题
+     * @param codetype - 代码类型
+     */
+    extractCodeBlock(opt) {
+        const { title, codetype } = opt;
+        const typePart = codetype !== undefined
+            ? codetype.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+            : '.*';
+        return this.extractBlock({ title, trimTitle: true })?.trim().replace(new RegExp("```" +
+            typePart +
+            "\\n([\\s\\S]+?)\\n" +
+            "```"), '$1');
     }
 }
 exports.Markdown = Markdown;

package/dist/UtilClass/ObsidianDepot.d.ts

@@ -0,0 +1,52 @@
+import type { MPromise } from '@zwa73/js-utils';
+import { Markdown } from "./Markdown";
+type ScanOpt = {
+    /**glob匹配符 默认 **\/info.md */
+    pattern?: string;
+    /**根目录 */
+    rootPath: string;
+    /**json代码块标题 如果提供 则会尝试解析对应代码对象
+     * 可以同时与 tomlTitle 使用, 最终结果会按顺序挑选第一个非空值
+     */
+    jsonTitle?: string;
+    /**toml代码块标题 如果提供 则会尝试解析对应代码对象
+     * 可以同时与 jsonTitle 使用, 最终结果会按顺序挑选第一个非空值
+     */
+    tomlTitle?: string;
+};
+type UpdateOpt = ScanOpt & {
+    updateFunc: (obj: ScanResult) => MPromise<{
+        content?: string;
+        data?: Record<string, any>;
+    }>;
+    /**markdown序列化参数 */
+    stringifyOpt?: Parameters<Awaited<ReturnType<typeof Markdown['parse']>>['stringify']>[0];
+};
+type ScanResult = {
+    /**info.md内容 */
+    content: string;
+    /**info.md所在目录的绝对路径 */
+    abspath: string;
+    /**info.md所在目录的相对路径 */
+    relpath: string;
+    /**info.md的绝对路径 */
+    infopath: string;
+    /**info.md解析后的Markdown对象 */
+    markdown: Markdown;
+    /**info.md中的代码类型 */
+    codetype: string;
+    /**info.md中的代码对象 */
+    codeobj: undefined | Record<string, any>;
+};
+export declare class ObsidianDepot {
+    /**将数组转为markdown列表文本 */
+    static toList(v?: string[]): string | undefined;
+    private constructor();
+    /**搜索info.md文件
+     * @param opt - 搜索选项
+     */
+    static scanMarkdown(opt: ScanOpt): Promise<ScanResult[]>;
+    /**搜索并更新info.md文件 */
+    static updateMarkdown(opt: UpdateOpt): Promise<void>;
+}
+export {};

package/dist/UtilClass/ObsidianDepot.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObsidianDepot = void 0;
+const fs_1 = __importDefault(require("fs"));
+const js_utils_1 = require("@zwa73/js-utils");
+const Constant_1 = require("../Constant");
+const pathe_1 = __importDefault(require("pathe"));
+const UtilFileTools_1 = require("../UtilFileTools");
+const UtilFunctions_1 = require("../UtilFunctions");
+const Markdown_1 = require("./Markdown");
+class ObsidianDepot {
+    /**将数组转为markdown列表文本 */
+    static toList(v) {
+        return v?.map(vv => ` - ${vv.trim()}`).join('\n');
+    }
+    constructor() { }
+    /**搜索info.md文件
+     * @param opt - 搜索选项
+     */
+    static async scanMarkdown(opt) {
+        const { pattern = "**/info.md", rootPath, jsonTitle, tomlTitle, } = opt;
+        const infoList = await UtilFileTools_1.UtilFT.fileSearchGlob(rootPath, pattern);
+        return await Promise.all(infoList.map(async (v) => {
+            const { dir } = pathe_1.default.parse(v);
+            const content = await fs_1.default.promises.readFile(v, 'utf-8');
+            const markdown = await Markdown_1.Markdown.parse(content);
+            const codetype = (jsonTitle != undefined && markdown.extractBlock({ title: jsonTitle, trimTitle: true })) ? 'json'
+                : (tomlTitle != undefined && markdown.extractBlock({ title: tomlTitle, trimTitle: true })) ? 'toml'
+                    : 'none';
+            const codeobj = await UtilFunctions_1.UtilFunc.match(codetype, {
+                json: () => JSON.parse(markdown.extractCodeBlock({ title: jsonTitle, codetype: 'json' }) ?? ''),
+                toml: async () => (await (0, Constant_1.importOptionPack)({
+                    name: '@iarna/toml',
+                    installTip: 'npm i @iarna/toml@2.2.5'
+                })).parse(markdown.extractCodeBlock({ title: tomlTitle, codetype: 'toml' }) ?? ''),
+                none: () => undefined
+            });
+            return {
+                content,
+                abspath: dir,
+                relpath: pathe_1.default.relative(rootPath, dir),
+                infopath: v,
+                markdown: await Markdown_1.Markdown.parse(content),
+                codetype,
+                codeobj,
+            };
+        }));
+    }
+    /**搜索并更新info.md文件 */
+    static async updateMarkdown(opt) {
+        const { stringifyOpt, updateFunc } = opt;
+        const scanResultList = await ObsidianDepot.scanMarkdown(opt);
+        await js_utils_1.Stream.from(scanResultList, 16).map(async (scanResult) => {
+            const { infopath } = scanResult;
+            const { content, data } = await updateFunc(scanResult);
+            await fs_1.default.promises.writeFile(infopath, await Markdown_1.Markdown.from({
+                data,
+                content
+            }).stringify(stringifyOpt));
+        }).apply();
+    }
+}
+exports.ObsidianDepot = ObsidianDepot;

package/dist/UtilClass/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Hbs';
 export * from './Markdown';
+export * from './ObsidianDepot';
 export type { EventData, DListMiddleNode, DListHeadNode, DListTailNode, DListInvalidNode, DListMaybeNode, DListNode, BridgeInterface } from "@zwa73/js-utils";
 export { Stream, Spool, SmartCache, SequenceQueue, PromiseQueue, Piper, EventSystem, DLinkedList, DelayQueue, Bridge } from "@zwa73/js-utils";

package/dist/UtilClass/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Bridge = exports.DelayQueue = exports.DLinkedList = exports.EventSystem = exports.Piper = exports.PromiseQueue = exports.SequenceQueue = exports.SmartCache = exports.Spool = exports.Stream = void 0;
 __exportStar(require("./Hbs"), exports);
 __exportStar(require("./Markdown"), exports);
+__exportStar(require("./ObsidianDepot"), exports);
 var js_utils_1 = require("@zwa73/js-utils");
 Object.defineProperty(exports, "Stream", { enumerable: true, get: function () { return js_utils_1.Stream; } });
 Object.defineProperty(exports, "Spool", { enumerable: true, get: function () { return js_utils_1.Spool; } });

package/dist/UtilCodecs.js

@@ -24,16 +24,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UtilCodec = void 0;
+const Constant_1 = require("./Constant");
 const he = __importStar(require("html-entities"));
-const UtilFunctions_1 = require("./UtilFunctions");
 /**引入tiktoken
  * 依赖于 tiktoken@1.0.7 但不会自动安装
  */
 async function importTikToken() {
-    const tik = await UtilFunctions_1.UtilFunc.dynamicImport("tiktoken");
-    if (tik == undefined)
-        UtilFunctions_1.UtilFunc.throwError(`npm包 tiktoken 动态导入失败, 此包不会随@zwa73/utils自动安装, 可能是未安装, 可使用 npm i tiktoken@1.0.7 来安装`);
-    return tik;
+    return await (0, Constant_1.importOptionPack)({
+        name: 'tiktoken',
+        installTip: 'npm i tiktoken@1.0.7'
+    });
 }
 //#endregion
 /**编码/解码器 */

package/dist/UtilFunctions.d.ts

@@ -44,8 +44,8 @@ declare class _UtilFunc {
     /**获取当前公网ipv4
      * 依赖于 public-ip@6.0.2 但不会自动安装
      */
-    static getPublicIpv4(): Promise<string | undefined>;
+    static getPublicIpv4(): Promise<string>;
 }
-export declare const UtilFunc: import("@zwa73/modular-mixer").ComposedClass<typeof _UtilFunc, typeof JsFunc, "__jsUtils", "prototype" | "preset" | "assignOption" | "genUUID" | "getTime" | "initField" | "initObject" | "afterward" | "sleep" | "getNeverResolvedPromise" | "retryPromise" | "timelimitPromise" | "mapEntries" | "eachField" | "stringifyJToken" | "sortJToken" | "assertType" | "assertLiteral" | "deepClone" | "isSafeNumber" | "dedent" | "throwError" | "getStack" | "getFuncLoc" | "cachePool" | "memoize" | "asyncize" | "lazyFunction" | "splitToChunk" | "mergeFromChunk" | "structEqual" | "concurrent" | "dynamicImport" | "createInjectable" | "createAsyncProxy" | "checkSharpSchema" | "unwarpReadonly" | "outcome" | "extractOutcome" | "success" | "failed" | "match" | "isStatus" | "eitherize" | "parseSrtTime" | "formatSrtTime" | "parseSrt" | "createSrt" | "ivk" | "range" | "s2l" | "l2s">;
+export declare const UtilFunc: import("@zwa73/modular-mixer").ComposedClass<typeof _UtilFunc, typeof JsFunc, "__jsUtils", "match" | "prototype" | "preset" | "assignOption" | "genUUID" | "getTime" | "initField" | "initObject" | "afterward" | "sleep" | "getNeverResolvedPromise" | "retryPromise" | "timelimitPromise" | "mapEntries" | "eachField" | "stringifyJToken" | "sortJToken" | "assertType" | "assertLiteral" | "deepClone" | "isSafeNumber" | "dedent" | "throwError" | "getStack" | "getFuncLoc" | "cachePool" | "memoize" | "asyncize" | "lazyFunction" | "splitToChunk" | "mergeFromChunk" | "structEqual" | "concurrent" | "dynamicImport" | "createInjectable" | "createAsyncProxy" | "checkSharpSchema" | "unwarpReadonly" | "outcome" | "extractOutcome" | "success" | "failed" | "isStatus" | "eitherize" | "parseSrtTime" | "formatSrtTime" | "parseSrt" | "createSrt" | "ivk" | "range" | "s2l" | "l2s">;
 export type UtilFunc = typeof UtilFunc;
 export {};

package/dist/UtilFunctions.js

@@ -33,6 +33,7 @@ const path_1 = __importDefault(require("path"));
 const js_utils_1 = require("@zwa73/js-utils");
 const modular_mixer_1 = require("@zwa73/modular-mixer");
 const UtilSymbol_1 = require("./UtilSymbol");
+const Constant_1 = require("./Constant");
 const UtilFileTools_1 = require("./UtilFileTools");
 const UtilLogger_1 = require("./UtilLogger");
 const HashAlgorithmList = [
@@ -130,13 +131,10 @@ class _UtilFunc {
      * 依赖于 public-ip@6.0.2 但不会自动安装
      */
     static async getPublicIpv4() {
-        const pip = await js_utils_1.JsFunc.dynamicImport('public-ip');
-        //if(_UtilFunc.publicIp===undefined)
-        //    _UtilFunc.publicIp = await import("public-ip");
-        if (pip == undefined) {
-            UtilLogger_1.SLogger.warn(`npm包 public-ip 动态导入失败, 此包不会随@zwa73/utils自动安装, 可能是未安装, 可使用 npm i public-ip@6.0.2 来安装`);
-            return undefined;
-        }
+        const pip = await (0, Constant_1.importOptionPack)({
+            name: 'public-ip',
+            installTip: 'npm i public-ip@6.0.2'
+        });
         return pip.publicIpv4();
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zwa73/utils",
-	"version": "1.0.278",
+	"version": "1.0.279",
 	"description": "my utils",
 	"main": "dist/index.js",
 	"scripts": {
@@ -19,18 +19,19 @@
 		"@zwa73/js-utils": "*",
 		"@zwa73/modular-mixer": "^1.0.8",
 		"form-data": "^4.0.2",
-		"glob": "^10.4.1",
 		"html-entities": "^2.3.3",
 		"http-proxy-agent": "^7.0.2",
 		"https-proxy-agent": "^7.0.6",
-		"json5": "^2.2.3",
-		"pathe": "^1.1.2",
 		"querystring": "^0.2.1",
 		"winston": "^3.10.0",
 		"winston-daily-rotate-file": "^4.7.1"
 	},
 	"peerDependencies": {
+		"@iarna/toml": "^2.2.5",
+		"glob": "^13.0.0",
 		"handlebars": "^4.7.8",
+		"json5": "^2.2.3",
+		"pathe": "^1.1.2",
 		"public-ip": "^6.0.2",
 		"tiktoken": "^1.0.7",
 		"yaml": "^2.8.1"
@@ -47,6 +48,9 @@
 		},
 		"yaml": {
 			"optional": true
+		},
+		"@iarna/toml": {
+			"optional": true
 		}
 	},
 	"devDependencies": {