meodp 0.0.6 → 0.0.7

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import * as PQueue from 'p-queue';
 import PQueue__default from 'p-queue';
 import * as playwright from 'playwright';
 import { Response, Request, Page } from 'playwright';
+import * as lowdb from 'lowdb';
 import winston from 'winston';
 import cliProgress from 'cli-progress';
 
@@ -17,7 +18,7 @@ declare const siteUrlMap: Map<string, {
     /**
      * 检查状态
      */
-    checkStatus: "pending" | "passed" | "failed" | "goto";
+    checkStatus: "pending" | "passed" | "failed" | "goto" | "ignored";
 }>;
 /**
  * site p-queue
@@ -170,6 +171,86 @@ interface MEODPConfig {
  */
 declare function checkLink(urlItem: MEODPUrlProps): Promise<void>;
 
+/**
+ * 站点中的链接
+ */
+interface MEODPSiteLinkItem {
+    url: string;
+    title?: string;
+    statusCode: number;
+    statusText?: string;
+    checkStatus: 'pending' | 'passed' | 'failed' | 'goto' | 'ignored' | 'timeout';
+    /**
+     * success requests
+     */
+    success: number;
+    /**
+     * failed requests
+     */
+    failed: number;
+    timeout: number;
+    /**
+     * ignored requests
+     */
+    ignored: number;
+    /**
+     * duration in ms
+     */
+    duration: number;
+    /**
+     * total requests
+     */
+    total: number;
+    requests: MEODPRequestItem[];
+}
+interface MEODPRequestItem {
+    /**
+     * @desc 是否失败
+     */
+    failed?: boolean;
+    /**
+     * @desc 是否被忽略
+     */
+    ignored?: boolean;
+    url?: string;
+    statusCode?: number;
+    statusText?: string;
+}
+interface MEODPSiteItem {
+    /**
+     * @desc 站点名称
+     */
+    name?: string;
+    /**
+     * url 内容为 html 时，将会检查页面上的所有资源
+     */
+    url: string;
+    /**
+     * @desc 站点标题
+     */
+    title?: string;
+    /**
+     * site links 站点其他链接
+     */
+    links: MEODPSiteLinkItem[];
+    /**
+     * 本次总体检查状态
+     */
+    checkStatus: 'passed' | 'failed' | 'pending';
+    /**
+     * all ignored urls
+     */
+    ignored: string[];
+}
+interface DBData {
+    config: MEODPConfig;
+    sites: Record<string, MEODPSiteItem>;
+}
+/**
+ * create json db
+ */
+declare function createLowDB(rootDir?: string): Promise<lowdb.Low<DBData>>;
+
 /**
  * 获取站点外链
  */
@@ -190,7 +271,7 @@ interface CheckSiteUrlOptions {
  * check url in site
  * @param url
  */
-declare function checkSiteUrl(url: string, options: CheckSiteUrlOptions): Promise<void>;
+declare function checkSiteUrl(url: string, options: CheckSiteUrlOptions): Promise<MEODPSiteLinkItem | undefined>;
 /**
  * 检查站点可访问性
  * - 死链
@@ -310,6 +391,9 @@ declare function getFormattedDuration(duration: number): string;
  * get formatted data from response
  */
 declare function getFormattedDataFromResponse(res: Response): {
+    /**
+     * 四舍五入 ms
+     */
     duration: number;
     durationText: string;
     statusCode: number;
@@ -359,4 +443,4 @@ declare function getMEODPUrlItemInfo(urlItem: MEODPUrlItem): {
     emoji: string;
 };
 
-export { type CheckSiteUrlOptions, LocalLog, type LocalLogOptions, type MEODPConfig, type MEODPUrlItem, type MEODPUrlProps, type MEODPUrlType, PQueueMap, type PageUrlEvent, type UrlCategoryInfo, type UrlMap, checkLink, checkMEODPUrl, checkSite, checkSiteMap, checkSiteUrl, checkUrlNomoduleAssets, createMEODPLogger, createWinstonLogger, defaultMEODPConfig, defineConfig, emojiMap, formatArgs, getBrowser, getFormattedDataFromResponse, getFormattedDuration, getMEODPUrlItemInfo, getSiteLinks, isLink, localLog, logUrlItemInfo, multiBar, parseUrlMap, progressBarMap, registerPageEvents, runByConfig, siteUrlMap };
+export { type CheckSiteUrlOptions, type DBData, LocalLog, type LocalLogOptions, type MEODPConfig, type MEODPRequestItem, type MEODPSiteItem, type MEODPSiteLinkItem, type MEODPUrlItem, type MEODPUrlProps, type MEODPUrlType, PQueueMap, type PageUrlEvent, type UrlCategoryInfo, type UrlMap, checkLink, checkMEODPUrl, checkSite, checkSiteMap, checkSiteUrl, checkUrlNomoduleAssets, createLowDB, createMEODPLogger, createWinstonLogger, defaultMEODPConfig, defineConfig, emojiMap, formatArgs, getBrowser, getFormattedDataFromResponse, getFormattedDuration, getMEODPUrlItemInfo, getSiteLinks, isLink, localLog, logUrlItemInfo, multiBar, parseUrlMap, progressBarMap, registerPageEvents, runByConfig, siteUrlMap };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import * as PQueue from 'p-queue';
 import PQueue__default from 'p-queue';
 import * as playwright from 'playwright';
 import { Response, Request, Page } from 'playwright';
+import * as lowdb from 'lowdb';
 import winston from 'winston';
 import cliProgress from 'cli-progress';
 
@@ -17,7 +18,7 @@ declare const siteUrlMap: Map<string, {
     /**
      * 检查状态
      */
-    checkStatus: "pending" | "passed" | "failed" | "goto";
+    checkStatus: "pending" | "passed" | "failed" | "goto" | "ignored";
 }>;
 /**
  * site p-queue
@@ -170,6 +171,86 @@ interface MEODPConfig {
  */
 declare function checkLink(urlItem: MEODPUrlProps): Promise<void>;
 
+/**
+ * 站点中的链接
+ */
+interface MEODPSiteLinkItem {
+    url: string;
+    title?: string;
+    statusCode: number;
+    statusText?: string;
+    checkStatus: 'pending' | 'passed' | 'failed' | 'goto' | 'ignored' | 'timeout';
+    /**
+     * success requests
+     */
+    success: number;
+    /**
+     * failed requests
+     */
+    failed: number;
+    timeout: number;
+    /**
+     * ignored requests
+     */
+    ignored: number;
+    /**
+     * duration in ms
+     */
+    duration: number;
+    /**
+     * total requests
+     */
+    total: number;
+    requests: MEODPRequestItem[];
+}
+interface MEODPRequestItem {
+    /**
+     * @desc 是否失败
+     */
+    failed?: boolean;
+    /**
+     * @desc 是否被忽略
+     */
+    ignored?: boolean;
+    url?: string;
+    statusCode?: number;
+    statusText?: string;
+}
+interface MEODPSiteItem {
+    /**
+     * @desc 站点名称
+     */
+    name?: string;
+    /**
+     * url 内容为 html 时，将会检查页面上的所有资源
+     */
+    url: string;
+    /**
+     * @desc 站点标题
+     */
+    title?: string;
+    /**
+     * site links 站点其他链接
+     */
+    links: MEODPSiteLinkItem[];
+    /**
+     * 本次总体检查状态
+     */
+    checkStatus: 'passed' | 'failed' | 'pending';
+    /**
+     * all ignored urls
+     */
+    ignored: string[];
+}
+interface DBData {
+    config: MEODPConfig;
+    sites: Record<string, MEODPSiteItem>;
+}
+/**
+ * create json db
+ */
+declare function createLowDB(rootDir?: string): Promise<lowdb.Low<DBData>>;
+
 /**
  * 获取站点外链
  */
@@ -190,7 +271,7 @@ interface CheckSiteUrlOptions {
  * check url in site
  * @param url
  */
-declare function checkSiteUrl(url: string, options: CheckSiteUrlOptions): Promise<void>;
+declare function checkSiteUrl(url: string, options: CheckSiteUrlOptions): Promise<MEODPSiteLinkItem | undefined>;
 /**
  * 检查站点可访问性
  * - 死链
@@ -310,6 +391,9 @@ declare function getFormattedDuration(duration: number): string;
  * get formatted data from response
  */
 declare function getFormattedDataFromResponse(res: Response): {
+    /**
+     * 四舍五入 ms
+     */
     duration: number;
     durationText: string;
     statusCode: number;
@@ -359,4 +443,4 @@ declare function getMEODPUrlItemInfo(urlItem: MEODPUrlItem): {
     emoji: string;
 };
 
-export { type CheckSiteUrlOptions, LocalLog, type LocalLogOptions, type MEODPConfig, type MEODPUrlItem, type MEODPUrlProps, type MEODPUrlType, PQueueMap, type PageUrlEvent, type UrlCategoryInfo, type UrlMap, checkLink, checkMEODPUrl, checkSite, checkSiteMap, checkSiteUrl, checkUrlNomoduleAssets, createMEODPLogger, createWinstonLogger, defaultMEODPConfig, defineConfig, emojiMap, formatArgs, getBrowser, getFormattedDataFromResponse, getFormattedDuration, getMEODPUrlItemInfo, getSiteLinks, isLink, localLog, logUrlItemInfo, multiBar, parseUrlMap, progressBarMap, registerPageEvents, runByConfig, siteUrlMap };
+export { type CheckSiteUrlOptions, type DBData, LocalLog, type LocalLogOptions, type MEODPConfig, type MEODPRequestItem, type MEODPSiteItem, type MEODPSiteLinkItem, type MEODPUrlItem, type MEODPUrlProps, type MEODPUrlType, PQueueMap, type PageUrlEvent, type UrlCategoryInfo, type UrlMap, checkLink, checkMEODPUrl, checkSite, checkSiteMap, checkSiteUrl, checkUrlNomoduleAssets, createLowDB, createMEODPLogger, createWinstonLogger, defaultMEODPConfig, defineConfig, emojiMap, formatArgs, getBrowser, getFormattedDataFromResponse, getFormattedDuration, getMEODPUrlItemInfo, getSiteLinks, isLink, localLog, logUrlItemInfo, multiBar, parseUrlMap, progressBarMap, registerPageEvents, runByConfig, siteUrlMap };

package/dist/index.mjs

@@ -1,19 +1,20 @@
-import { g as getBrowser, s as siteUrlMap } from './shared/meodp.9c5df07b.mjs';
-export { L as LocalLog, P as PQueueMap, a as checkLink, c as checkMEODPUrl, f as checkSite, e as checkSiteUrl, d as checkUrlNomoduleAssets, k as createMEODPLogger, m as createWinstonLogger, h as defaultMEODPConfig, i as defineConfig, x as emojiMap, q as formatArgs, u as getFormattedDataFromResponse, t as getFormattedDuration, y as getMEODPUrlItemInfo, b as getSiteLinks, v as isLink, j as localLog, l as logUrlItemInfo, n as multiBar, w as parseUrlMap, p as progressBarMap, o as registerPageEvents, r as runByConfig } from './shared/meodp.9c5df07b.mjs';
-import 'consola';
-import 'p-queue';
+import { g as getBrowser, s as siteUrlMap } from './shared/meodp.5489574b.mjs';
+export { L as LocalLog, P as PQueueMap, a as checkLink, c as checkMEODPUrl, f as checkSite, e as checkSiteUrl, d as checkUrlNomoduleAssets, j as createLowDB, m as createMEODPLogger, n as createWinstonLogger, h as defaultMEODPConfig, i as defineConfig, y as emojiMap, t as formatArgs, v as getFormattedDataFromResponse, u as getFormattedDuration, z as getMEODPUrlItemInfo, b as getSiteLinks, w as isLink, k as localLog, l as logUrlItemInfo, o as multiBar, x as parseUrlMap, p as progressBarMap, q as registerPageEvents, r as runByConfig } from './shared/meodp.5489574b.mjs';
 import 'consola/utils';
 import 'playwright';
 import 'node:path';
 import 'node:process';
-import 'date-fns';
-import 'fs-extra';
-import 'strip-ansi';
-import 'winston';
+import 'consola';
+import 'lowdb/node';
+import 'p-queue';
 import 'cli-progress';
 import 'cli-progress/lib/options.js';
 import 'cli-progress/lib/format-bar.js';
 import 'cli-progress/lib/format-time.js';
+import 'date-fns';
+import 'fs-extra';
+import 'strip-ansi';
+import 'winston';
 
 async function checkSiteMap(urlItem) {
   const { url } = urlItem;