@pnnh/atom 0.6.0

package/dist/common.d.ts

@@ -0,0 +1,220 @@
+import { ParsedQuery } from 'query-string';
+import parseUri from 'parse-uri';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { JSX } from 'react';
+import { Token } from 'marked';
+
+declare const langEn = "en";
+declare const langZh = "zh";
+declare const langZhant = "zhant";
+declare const defaultLanguage = "en";
+declare const supportedLanguages: string[];
+declare function isSupportedLanguage(lang: string): boolean;
+declare function isLangEn(lang: string): boolean;
+declare function isLangZh(lang: string): boolean;
+declare function getLangDefault(lang: string): string;
+declare function getLanguageFromPathname(pathname: string): string | undefined;
+declare function replaceLanguageInPathname(pathname: string, lang: string): string;
+declare function localText(lang: string, zhText: string, enText: string): string;
+
+declare function uuidV1(): string;
+declare function isValidUUID(uuid: string): boolean;
+declare function uuidV4(): string;
+declare function uuidV6(): string;
+declare function uuidV7(): string;
+declare const EmptyUUID: "00000000-0000-0000-0000-000000000000";
+declare function isEmptyUUID(uuid: string): boolean;
+
+/**
+ * 将字符串转换为base64编码的字符串
+ * @param state - 待编码的字符串
+ * @returns base64编码的字符串
+ */
+declare function encodeBase64String(state: string | unknown): string;
+declare function encodeBase32String(state: string | unknown): string;
+declare function decodeBase32String(base32State: string): string;
+/**
+ * 将base64编码的字符串转换为字符串
+ * @param base64State - 待解码的base64编码的字符串
+ * @returns 解码后的字符串
+ */
+declare function decodeBase64String(base64State: string): string;
+declare function binaryToBase58String(data: Uint8Array): string;
+declare function generateUuid(): string;
+declare function generateUuidV7(): string;
+declare function stringToUuid(uuidString: string): string;
+declare function isValidUuid(uuidString: string): boolean;
+declare function uuidToBase58(uuidString: string): string;
+declare function tryBase58ToUuid(base58String: string): string | undefined;
+declare function mustBase58ToUuid(base58String: string): string;
+declare function stringToBase58(data: string, flavor?: string): string;
+declare function encodeBase58String(state: string): string;
+declare function decodeBase58String(base58State: string): string;
+declare function base58ToString(data: string, flavor?: string): string;
+/**
+ * 将字符串转换为md5字符串
+ * @param data - 待转换的字符串
+ * @returns md5字符串
+ */
+declare function stringToMd5(data: string): string;
+
+declare function convertToNumber(value: string | number | (string | null)[] | null | undefined): number | undefined;
+
+declare function encodeSHA256(data: string): string;
+declare function encodeSHA512(data: string): string;
+declare function encodeMD5(data: string): string;
+
+declare function formatRfc3339(date: string | Date): string;
+declare function getTimestamp(): number;
+
+declare function validateEmail(email: string): RegExpMatchArray | null;
+
+declare function stringHashCode(str: string): number;
+
+declare function encodeHtml(rawHtml: string | null | undefined): string;
+
+declare function isScreenPhone(): boolean;
+declare function isScreenTablet(): boolean;
+declare function isScreenDesktop(): boolean;
+
+declare function getMimeType(path: string): string;
+type getType = typeof getMimeType;
+declare function isImageType(type: string): boolean;
+
+interface Pagination {
+    offset: number;
+    limit: number;
+    page: number;
+    size: number;
+}
+declare class FullPagination {
+    totalCount: number;
+    pageSize: number;
+    currentPage: number;
+    startPage: number;
+    endPage: number;
+    previousPage: number;
+    nextPage: number;
+    maxPage: number;
+}
+declare function calcPagination(currentPage: number, totalCount: number, pageSize: number): FullPagination;
+declare function createPagination(offset: number, limit: number): Pagination;
+declare function createPaginationByPage(page: number, limit: number): Pagination;
+
+declare function replaceSearchParams(searchParams: Record<string, string>, key: string, value: string): string;
+declare function replaceParsedQuery(parsedQuery: ParsedQuery<string>, key: string, value: string): string;
+declare function replaceQueryString(rawQuery: string, key: string, value: string): string;
+declare function replaceQueryStringNew(rawQuery: string, key: string, value: string): string;
+
+declare function randomString(chars: string, length: number): string;
+interface randomPasswordOptions {
+    number?: boolean;
+    letter?: boolean;
+    uppercaseLetter?: boolean;
+    symbol?: boolean;
+}
+declare function randomPassword(length: number, options: randomPasswordOptions): string;
+
+declare function generatorRandomString(length: number): string;
+declare function STSubString(str: string | undefined, length: number, suffix?: string): string;
+declare function isValidName(s: string): boolean;
+
+declare function stringToUri(value: string): parseUri.URI;
+declare function isValidUrl(address: string): boolean;
+declare function sanitizeUrl(src: string | undefined): string;
+
+declare const CodeOk = 200;
+declare const CodeFailed = 500;
+declare const CodeBadRequest = 400;
+declare const CodeNotFound = 404;
+declare const CodeUnauthorized = 401;
+interface PLBizError extends Error {
+    code: number;
+    message: string;
+}
+declare function PLParseBizError(error: Error): PLBizError;
+interface PLSelectData<T> {
+    page: number;
+    size: number;
+    count: number;
+    range: T[];
+}
+type PLSelectResult<T> = CommonResult<PLSelectData<T>>;
+type PLGetResult<T> = CommonResult<T>;
+type PLInsertResult = CommonResult<string>;
+type ATInsertResult<T> = CommonResult<T>;
+type PLDeleteResult = CommonResult<string>;
+type PLUpdateResult = CommonResult<string>;
+declare function emptySelectResult(): {
+    code: number;
+    message: string;
+    data: {
+        page: number;
+        size: number;
+        count: number;
+        range: never[];
+    };
+};
+interface CommonResult<T> {
+    code: number;
+    message: string;
+    data: T;
+}
+declare const SymbolUnknown: unique symbol;
+
+declare class TocItem {
+    title: string;
+    header: number;
+    id: string;
+}
+
+interface TextNode {
+    name: string;
+    text: string;
+}
+interface SteleNode {
+    id: string;
+    name: string;
+    text: string;
+    raw: string;
+    children?: SteleNode[];
+}
+interface HeadingNode extends SteleNode {
+    header: number;
+}
+interface ParagraphNode extends SteleNode {
+}
+interface CodeBlockNode extends SteleNode {
+    language: string;
+}
+interface ListNode extends SteleNode {
+    ordered: boolean;
+    start: number;
+    loose: boolean;
+}
+interface LinkNode extends SteleNode {
+    href: string;
+}
+interface ImageNode extends SteleNode {
+    href: string;
+}
+interface SteleBody {
+    name: string;
+    children: SteleNode[];
+}
+interface SteleBody extends SteleNode {
+}
+declare function buildText(node: SteleNode): string;
+
+declare function buildNodeView(tocList: Array<TocItem>, node: SteleNode, assetsUrl: string): JSX.Element;
+declare function buildCodeBlock(tocList: Array<TocItem>, node: CodeBlockNode): react_jsx_runtime.JSX.Element;
+declare function buildImage(node: ImageNode, assetsUrl: string): react_jsx_runtime.JSX.Element;
+declare function buildList(node: ListNode, assetsUrl: string): react_jsx_runtime.JSX.Element;
+
+declare function tokenToNode(token: Token): SteleNode;
+declare function markdownToStele(markdown: string): SteleBody;
+
+declare function atomCommonHello(): Promise<string>;
+
+export { CodeBadRequest, CodeFailed, CodeNotFound, CodeOk, CodeUnauthorized, EmptyUUID, FullPagination, PLParseBizError, STSubString, SymbolUnknown, TocItem, atomCommonHello, base58ToString, binaryToBase58String, buildCodeBlock, buildImage, buildList, buildNodeView, buildText, calcPagination, convertToNumber, createPagination, createPaginationByPage, decodeBase32String, decodeBase58String, decodeBase64String, defaultLanguage, emptySelectResult, encodeBase32String, encodeBase58String, encodeBase64String, encodeHtml, encodeMD5, encodeSHA256, encodeSHA512, formatRfc3339, generateUuid, generateUuidV7, generatorRandomString, getLangDefault, getLanguageFromPathname, getMimeType, getTimestamp, isEmptyUUID, isImageType, isLangEn, isLangZh, isScreenDesktop, isScreenPhone, isScreenTablet, isSupportedLanguage, isValidName, isValidUUID, isValidUrl, isValidUuid, langEn, langZh, langZhant, localText, markdownToStele, mustBase58ToUuid, randomPassword, randomString, replaceLanguageInPathname, replaceParsedQuery, replaceQueryString, replaceQueryStringNew, replaceSearchParams, sanitizeUrl, stringHashCode, stringToBase58, stringToMd5, stringToUri, stringToUuid, supportedLanguages, tokenToNode, tryBase58ToUuid, uuidToBase58, uuidV1, uuidV4, uuidV6, uuidV7, validateEmail };
+export type { ATInsertResult, CodeBlockNode, CommonResult, HeadingNode, ImageNode, LinkNode, ListNode, PLBizError, PLDeleteResult, PLGetResult, PLInsertResult, PLSelectData, PLSelectResult, PLUpdateResult, Pagination, ParagraphNode, SteleBody, SteleNode, TextNode, getType };