qidian-shared 0.0.1-beta.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025-present QiDian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+# qidian-shared
+
+QiDian 共享工具函数和钩子。
+
+## 安装
+
+```bash
+npm install qidian-shared
+```
+
+## 使用
+
+```typescript
+// 导入 utils、hooks
+import { toMoney, isEmpty, useCsl } from 'qidian-shared'
+```
+
+## LICENSE
+
+[MIT](LICENSE)

package/dist/directive/index.d.ts

@@ -0,0 +1 @@
+export * from './resize';

package/dist/directive/resize.d.ts

@@ -0,0 +1,17 @@
+import type { App, DirectiveBinding } from 'vue';
+interface ResizeElement extends HTMLElement {
+    _resizeObserver?: ResizeObserver;
+    _resizeHandler?: () => void;
+}
+export interface ResizeDirectiveBinding extends DirectiveBinding {
+    value: (entries: ResizeObserverEntry[]) => void;
+}
+export declare const resizeDirective: {
+    mounted(el: ResizeElement, binding: ResizeDirectiveBinding): void;
+    updated(el: ResizeElement, binding: ResizeDirectiveBinding): void;
+    unmounted(el: ResizeElement): void;
+};
+export declare const resize: {
+    install(app: App): void;
+};
+export default resize;

package/dist/hooks/index.d.ts

@@ -0,0 +1,5 @@
+export * from './useActivated';
+export * from './useLog';
+export * from './useProxy';
+export * from './useTimer';
+export * from './useService';

package/dist/hooks/useActivated.d.ts

@@ -0,0 +1,3 @@
+export declare function useActivated(): {
+    activated: import("vue").Ref<boolean, boolean>;
+};

package/dist/hooks/useLog.d.ts

@@ -0,0 +1,12 @@
+type CslType = 'log' | 'warn' | 'error';
+type Csl = {
+    [key in CslType]: {
+        (childModule: ChildModule, ...rest: unknown[]): void;
+        dev(childModule: ChildModule, ...rest: unknown[]): void;
+    };
+} & {
+    useNext(childModule: ChildModule): Csl;
+};
+type ChildModule = string | number | Array<string | number>;
+export declare function useCsl(module: string | Array<string>): Csl;
+export {};

package/dist/hooks/useProxy.d.ts

@@ -0,0 +1 @@
+export declare function useProxy(): import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import("vue").ComponentProvideOptions>, {}, {}, "", {}, any>;

package/dist/hooks/useService/index.d.ts

@@ -0,0 +1,3 @@
+export * from './loadMore';
+export * from './pagination';
+export type { ServicePageParams, ServicePagination, ServicePageRes, ServicePageDataType, ServicePageBaseOptions, ServicePageLoadMoreOptions, ServicePaginationOptions } from './types';

package/dist/hooks/useService/loadMore.d.ts

@@ -0,0 +1,10 @@
+import type { Ref } from 'vue';
+import type { ServicePageDataType, ServicePageLoadMoreOptions, ServicePageParams, ServicePagination } from './types';
+import { useLoadMore } from 'vue-request';
+export declare function useServiceLoadMore<D = unknown, R = unknown, P = ServicePageParams, TP = P, Pag extends ServicePagination = Ref<{
+    pageSize?: number;
+}>>({ service, manual, transformParams, transformRes, pagination, onBefore, onAfter, onSuccess, onError }: ServicePageLoadMoreOptions<D, R, P, TP, Pag>): Omit<ReturnType<typeof useLoadMore<ServicePageDataType<D>>>, "dataList"> & {
+    firstLoad: Ref<boolean>;
+    manualTriggerLoad: Ref<boolean>;
+    dataList: Ref<D[]>;
+};

package/dist/hooks/useService/pagination.d.ts

@@ -0,0 +1,10 @@
+import type { Ref } from 'vue';
+import type { ServicePaginationOptions, ServicePageParams, ServicePagination, ServicePageDataType } from './types';
+import { usePagination } from 'vue-request';
+export declare function useServicePagination<D = unknown, R = unknown, P = ServicePageParams, TP = P, Pag extends ServicePagination = Ref<{
+    pageSize?: number;
+}>>({ service, manual, cacheKey, cacheTime, pollingInterval, transformParams, transformRes, pagination, onBefore, onAfter, onSuccess, onError }: ServicePaginationOptions<D, R, P, TP, Pag> & {}): ReturnType<typeof usePagination<ServicePageDataType<D>>> & {
+    firstLoad: Ref<boolean>;
+    manualTriggerLoad: Ref<boolean>;
+    dataList: Ref<D[]>;
+};

package/dist/hooks/useService/types.d.ts

@@ -0,0 +1,44 @@
+import type { MaybeRef } from 'vue';
+import type { LoadMoreBaseOptions, PaginationOptions } from 'vue-request';
+export interface ServicePageParams {
+    pageSize: number;
+    pageNum: number;
+}
+export interface ServicePageRes<T> {
+    records: T[];
+    total?: number;
+}
+export type ServicePagination = MaybeRef<false | {
+    pageSize?: number;
+}>;
+export interface ServicePageDataType<T> {
+    list: T[];
+    page?: number;
+    total?: number;
+}
+type PageParams<T> = T extends false ? undefined : ServicePageParams;
+type ServicePageLoadMoreBaseOptions<T> = LoadMoreBaseOptions<ServicePageDataType<T>>;
+type ServicePaginationBaseOptions<T> = PaginationOptions<ServicePageDataType<T>, unknown[]>;
+export interface ServicePageBaseOptions<D = unknown, R = unknown, P = ServicePageParams, TP = P, Pag extends ServicePagination = ServicePagination> {
+    service: (params: TP) => Promise<R>;
+    manual?: boolean;
+    transformParams?: (params: PageParams<Pag>) => TP;
+    transformRes?: (res: R) => ServicePageRes<D>;
+    pagination?: Pag;
+}
+export interface ServicePageLoadMoreOptions<D = unknown, R = unknown, P = ServicePageParams, TP = P, Pag extends ServicePagination = ServicePagination> extends ServicePageBaseOptions<D, R, P, TP, Pag> {
+    onBefore?: ServicePageLoadMoreBaseOptions<D>['onBefore'];
+    onAfter?: ServicePageLoadMoreBaseOptions<D>['onAfter'];
+    onSuccess?: ServicePageLoadMoreBaseOptions<D>['onSuccess'];
+    onError?: ServicePageLoadMoreBaseOptions<D>['onError'];
+}
+export interface ServicePaginationOptions<D = unknown, R = unknown, P = ServicePageParams, TP = P, Pag extends ServicePagination = ServicePagination> extends ServicePageBaseOptions<D, R, P, TP, Pag> {
+    cacheKey?: ServicePaginationBaseOptions<D>['cacheKey'];
+    cacheTime?: ServicePaginationBaseOptions<D>['cacheTime'];
+    pollingInterval?: ServicePaginationBaseOptions<D>['pollingInterval'];
+    onBefore?: ServicePageLoadMoreBaseOptions<D>['onBefore'];
+    onAfter?: ServicePageLoadMoreBaseOptions<D>['onAfter'];
+    onSuccess?: ServicePageLoadMoreBaseOptions<D>['onSuccess'];
+    onError?: ServicePageLoadMoreBaseOptions<D>['onError'];
+}
+export {};

package/dist/hooks/useTimer.d.ts

@@ -0,0 +1,22 @@
+export declare function useTimer(type?: 'timeout' | 'interval'): {
+    timer: import("vue").Ref<{
+        close: () => NodeJS.Timeout;
+        hasRef: () => boolean;
+        ref: () => NodeJS.Timeout;
+        refresh: () => NodeJS.Timeout;
+        unref: () => NodeJS.Timeout;
+        _onTimeout: (...args: any[]) => void;
+        [Symbol.toPrimitive]: () => number;
+        [Symbol.dispose]: () => void;
+    } | null, NodeJS.Timeout | {
+        close: () => NodeJS.Timeout;
+        hasRef: () => boolean;
+        ref: () => NodeJS.Timeout;
+        refresh: () => NodeJS.Timeout;
+        unref: () => NodeJS.Timeout;
+        _onTimeout: (...args: any[]) => void;
+        [Symbol.toPrimitive]: () => number;
+        [Symbol.dispose]: () => void;
+    } | null>;
+    clearTimer: () => void;
+};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './directive';
+export * from './hooks';
+export * from './utils';