soonjs 0.0.5

package/dist/index.d.ts

@@ -0,0 +1,135 @@
+import { PassThrough } from 'stream';
+import { z, ZodType } from 'zod';
+import { default as Observable } from 'zen-observable';
+import { APIOptionsBase, Context, Middleware, PazuAppOptions, PazuFetchOptions, Response, APIOptions } from './types';
+import { vitePluginPazuServer } from './vite-plugin-pazu-server';
+import { vitePluginPazuClient } from './vite-plugin-pazu-client';
+
+export interface Meta {
+}
+export interface UserContext {
+}
+export interface Platform {
+}
+export interface Config {
+}
+export { Context, PazuFetchOptions };
+export type ReturnRealType<T extends (...args: any) => any | Promise<(...args: any) => any>, R = ReturnType<T>> = R extends Promise<infer U> ? U : R;
+export type ReturnConfig<ConfigDefine extends () => any, T = ReturnType<ConfigDefine>> = T extends Promise<infer U> ? U : T;
+export declare class PazuApp {
+    private options;
+    private apis;
+    private middlewares;
+    private defaultMiddlewares;
+    private api404;
+    private fnMiddleware;
+    private getId;
+    config: Config;
+    apiList: APIOptions[];
+    constructor(options?: PazuAppOptions, callback?: (error: any, app: PazuApp) => void);
+    private init;
+    /**
+     * 调用 API
+     */
+    fetchRaw(url: string, body?: any, pazuFetchOptions?: PazuFetchOptions): Promise<Response<any>>;
+    fetch(url: string, body?: any, pazuFetchOptions?: PazuFetchOptions): Promise<any>;
+}
+export declare const pazuApiSymbol: unique symbol;
+/**
+ * 定义 API
+ */
+export declare function defineApi<BodySchema extends ZodType<any, any, any>, CustomBody, Data>(options: APIOptionsBase & {
+    /**
+     * api body 验证模式
+     */
+    bodySchema?: BodySchema;
+    /**
+     * api执行方法
+     */
+    action: (body: BodySchema extends null ? CustomBody : z.infer<BodySchema>, context: Context<{
+        bodySchema?: BodySchema;
+    }>) => Promise<Data> | Data;
+}): {
+    path?: string;
+    method?: "get" | "head" | "post" | "put" | "delete" | "connect" | "options" | "trace" | "patch" | "all";
+    disabled?: boolean;
+    name?: string;
+    desc?: string;
+    tags?: string[];
+    meta?: Meta;
+    /**
+     * api body 验证模式
+     */
+    bodySchema?: BodySchema;
+    /**
+     * api执行方法
+     */
+    action: (body: BodySchema extends null ? CustomBody : z.infer<BodySchema>, context: Context<{
+        bodySchema?: BodySchema;
+    }>) => Promise<Data> | Data;
+};
+export declare const pazuServiceSymbol: unique symbol;
+/**
+ * 定义服务，使用时会以单例形式被调用
+ */
+export declare function defineService<T>(args: {
+    /** 服务名称，必须声明才能自动注入且在 client 中使用 */
+    serviceName?: string;
+    /** 是否自动注入到 contenxt 中，默认为 false */
+    autoInject?: boolean;
+    /** 是否在 client 中启用，默认为 false */
+    enableClient?: boolean;
+    /** 服务函数 */
+    service: (app: PazuApp) => T | Promise<T>;
+}): () => Promise<T>;
+/**
+ * 定义中间件
+ */
+export declare function defineMiddleware<T extends Middleware>(middlewareFn: T): T;
+/**
+ * 定义配置信息
+ */
+export declare function defineConfig<T>(configFn: () => T | Promise<T>): () => T | Promise<T>;
+/**
+ * 创建 PazuApp 实例，只允许存在一个
+ */
+export declare function createPazuApp(options?: PazuAppOptions): Promise<PazuApp>;
+/**
+ * 错误
+ */
+export declare function CodeError(message?: string, code?: number): Error;
+/**
+ * 使用 SSE，在 API action 中返回该 SSE
+ */
+export declare function useSSE<T>({ pingTime, action, }: {
+    pingTime?: number;
+    action: (subscriber: {
+        closed: boolean;
+        send(value: {
+            event?: string;
+            data: T;
+        }): void;
+        error(message: string): void;
+        close(): void;
+    }) => any | Promise<any>;
+}): Observable<{
+    event: string;
+    data?: T;
+    message: string;
+}>;
+/**
+ * 判断是否为 SSE Body
+ */
+export declare function isSSEBody(body: any): boolean;
+/**
+ * 处理 SSE Body
+ */
+export declare function resolveSSEBody(body: any): PassThrough;
+/**
+ * zen-observable
+ */
+export { Observable };
+/**
+ * Vite Plugin
+ */
+export { vitePluginPazuServer, vitePluginPazuClient };