@ctil/gql 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,300 @@
+import { DocumentNode } from 'graphql';
+
+interface RequestConfig {
+    endpoint?: string;
+    Authorization?: string;
+    headers?: Record<string, string>;
+    loginInfo?: UserToken | null | undefined;
+}
+/** 拦截器接口 */
+interface RequestInterceptor {
+    /** 请求发出前拦截，可修改 query、variables、headers */
+    onRequest?: (params: {
+        query: string;
+        variables?: Record<string, any>;
+        headers: Record<string, string | undefined> & {
+            "X-Device-Id"?: string;
+            "X-Device-Name"?: string;
+        };
+    }) => Promise<typeof params> | typeof params;
+    /** 响应成功拦截，可修改返回结构 */
+    onResponse?: (response: any) => Promise<any> | any;
+    /** 错误拦截，可做统一错误处理或重试 */
+    onError?: (error: any) => Promise<any> | any;
+}
+interface requestResult<T = any> {
+    [key: string]: T;
+}
+interface UserToken {
+    /** 用户 ID */
+    userId: number;
+    /** 登录账号 */
+    loginAccount: string;
+    /** 访问 Token */
+    token: string;
+    /** 刷新 Token */
+    refreshToken: string;
+    /** 访问 Token 过期时间 */
+    expireAt: string;
+    /** 刷新 Token 过期时间 */
+    refreshExpireAt: string;
+    /** 设备 ID */
+    deviceId?: string;
+    /** 设备名称 */
+    deviceName?: string;
+    /** 登录时间 */
+    loginTime?: string;
+    /** 登录 IP */
+    requestIp?: string;
+    /** 客户端信息 */
+    userAgent?: string;
+    /** 上次刷新时间 */
+    lastRefreshTime?: string;
+    /** 用户角色编码列表 */
+    roles: string[];
+    /** 用户权限编码列表 */
+    permissions: string[];
+}
+
+declare class CCRequest {
+    private config;
+    private client;
+    private headers;
+    private deviceInfoPromise;
+    private interceptors;
+    constructor(config: RequestConfig);
+    /** 注册一个拦截器（支持多个） */
+    use(interceptor: RequestInterceptor): void;
+    /** 构建 GraphQLClient 实例 */
+    private buildClient;
+    /** 构建初始 headers */
+    private buildHeaders;
+    setToken(token: string): void;
+    removeToken(): void;
+    setLoginInfo(loginInfo: UserToken, remember?: boolean): void;
+    /** 加载登录信息（含访问 token 和刷新 token 过期检查） */
+    /** 加载登录信息（仅负责加载，不负责刷新） */
+    loadLoginInfo(): UserToken | null;
+    getLoginInfo(): UserToken | null;
+    removeLoginInfo(): void;
+    setEndpoint(endpoint: string): void;
+    setHeader(key: string, value: string): void;
+    setHeaders(headers: Record<string, string>): void;
+    removeHeader(key: string): void;
+    clearHeaders(): void;
+    private ensureTokenValid;
+    request<T = any>(query: string | DocumentNode, variables?: Record<string, any>): Promise<T>;
+}
+
+/** 初始化全局客户端 */
+declare function initGraphQLClient(config: RequestConfig): CCRequest;
+/** 获取全局客户端实例 */
+declare function getClient(): CCRequest;
+/** 注册全局拦截器 */
+declare const useInterceptor: (interceptor: RequestInterceptor) => void;
+declare const setToken: (token: string) => void;
+declare const removeToken: () => void;
+declare const setEndpoint: (endpoint: string) => void;
+declare const setHeader: (key: string, value: string) => void;
+declare const setHeaders: (headers: Record<string, string>) => void;
+declare const removeHeader: (key: string) => void;
+declare const clearHeaders: () => void;
+
+type FieldInput = string | {
+    [key: string]: FieldNode;
+};
+interface FieldNode {
+    fields: FieldInput[];
+    where?: WhereInput;
+    orderBy?: Record<string, any>;
+    distinctOn?: string[];
+    limit?: number;
+    offset?: number;
+}
+interface WhereInput {
+    _and?: WhereInput[];
+    _or?: WhereInput[];
+    _not?: WhereInput;
+    [field: string]: any;
+}
+
+interface QueryInput {
+    operationName: string;
+    fields?: FieldInput[];
+    variables?: Record<string, any>;
+    where?: WhereInput;
+    orderBy?: Record<string, any>;
+    distinctOn?: string[];
+    limit?: number;
+    offset?: number;
+}
+interface QueryPageListInput {
+    operationName: string;
+    fields: FieldInput[];
+    variables?: Record<string, any>;
+    where?: WhereInput;
+    orderBy?: Record<string, any>;
+    distinctOn?: string[];
+    size?: number;
+    page?: number;
+}
+interface QueryByIdInput {
+    operationName: string;
+    fields: FieldInput[];
+    pk: string | number;
+}
+interface QueryAggregateInput {
+    operationName: string;
+    fields: FieldInput[];
+    aggregateFields?: AggregateFieldInput;
+    variables?: Record<string, any>;
+    where?: WhereInput;
+    distinctOn?: string[];
+}
+interface AggregateFieldInput {
+    count?: boolean;
+    sum?: string[];
+    avg?: string[];
+    max?: string[];
+    min?: string[];
+}
+
+interface InsertOneInput {
+    operationName: string;
+    fields: FieldInput[];
+    data: Record<string, any>;
+    variables?: Record<string, any>;
+}
+interface BatchInsertInput {
+    operationName: string;
+    fields: FieldInput[];
+    datas: Record<string, any>[];
+    variables?: Record<string, any>;
+}
+interface UpdateInput {
+    operationName: string;
+    fields: FieldInput[];
+    _set: Record<string, any>;
+    where: WhereInput;
+    variables?: Record<string, any>;
+}
+interface BatchUpdateInput {
+    operationName: string;
+    fields: FieldInput[];
+    _set: Record<string, any>[];
+    variables?: Record<string, any>;
+}
+interface UpdateByPkInput {
+    operationName: string;
+    fields: FieldInput[];
+    _set: Record<string, any>;
+    pk_columns: string | number;
+    variables?: Record<string, any>;
+}
+interface DeleteByIdInput {
+    operationName: string;
+    fields: FieldInput[];
+    pk_columns: string | number;
+    variables?: Record<string, any>;
+}
+interface DeleteInput {
+    operationName: string;
+    fields: FieldInput[];
+    where: WhereInput;
+    variables?: Record<string, any>;
+}
+
+interface SendCodeInput {
+    phone: string;
+    dataFields?: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface VerifyCodeInput {
+    code: string;
+    phone: string;
+    variables?: Record<string, any>;
+}
+
+interface LoginInput {
+    account: string;
+    password: string;
+    deviceId?: string;
+    variables?: Record<string, any>;
+    remember?: boolean;
+}
+interface RegisterUserInput {
+    user: Record<string, any>;
+    fields: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface LogoutInput {
+    dataFields?: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface LogoutDeviceInput {
+    deviceId: string;
+    dataFields?: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface RefreshTokenInput {
+    refreshToken: string;
+    variables?: Record<string, any>;
+    remember?: boolean;
+}
+
+declare const auth: {
+    login<T = requestResult<UserToken>>(input: LoginInput): Promise<T>;
+    refreshToken<T = requestResult<UserToken>>(input: RefreshTokenInput): Promise<T>;
+    register<T = requestResult<any>>(input: RegisterUserInput): Promise<T>;
+    logout<T = requestResult<any>>(): Promise<T>;
+    logoutAllDevices<T = requestResult<any>>(): Promise<T>;
+    logoutDevice<T = requestResult<any>>(deviceId: string): Promise<T>;
+};
+
+declare const query: {
+    list<T = requestResult<any>>(input: QueryInput, useCache?: boolean, ttl?: number): Promise<T>;
+    byId<T = requestResult<any>>(input: QueryByIdInput, useCache?: boolean, ttl?: number): Promise<T>;
+    page<T = requestResult<any>>(input: QueryPageListInput, useCache?: boolean, ttl?: number): Promise<T>;
+    aggregate<T = requestResult<any>>(input: QueryAggregateInput, useCache?: boolean, ttl?: number): Promise<T>;
+};
+
+declare const mutation: {
+    insertOne<T = requestResult<any>>(input: InsertOneInput): Promise<T>;
+    batchInsert<T = requestResult<any>>(input: BatchInsertInput): Promise<T>;
+    update<T = requestResult<any>>(input: UpdateInput): Promise<T>;
+    batchUpdate<T = requestResult<any>>(input: BatchUpdateInput): Promise<T>;
+    updateByPk<T = requestResult<any>>(input: UpdateByPkInput): Promise<T>;
+    delete<T = requestResult<any>>(input: DeleteInput): Promise<T>;
+    deleteById<T = requestResult<any>>(input: DeleteByIdInput): Promise<T>;
+};
+
+declare const sms: {
+    send<T = requestResult<any>>(input: SendCodeInput): Promise<T>;
+    verify<T = requestResult<any>>(input: VerifyCodeInput): Promise<T>;
+};
+
+/**
+ * 原生 GraphQL 执行模块
+ * 可执行任意 query / mutation / subscription
+ */
+declare const gql: {
+    /**
+     * 执行任意 GraphQL 文本或 DocumentNode
+     * @param query 原生 GQL 文本或 DocumentNode
+     * @param variables 可选变量
+     * @returns Promise<T>
+     */
+    execute<T = requestResult<any>>(query: string | DocumentNode, variables?: Record<string, any>): Promise<T>;
+};
+
+interface DeviceInfo {
+    deviceId: string;
+    deviceName: string;
+    env: "node" | "browser";
+}
+/** 浏览器端设备信息 */
+declare function getBrowserDeviceInfo(): Promise<DeviceInfo>;
+/** 跨平台获取设备信息 */
+declare function getDeviceInfo(): Promise<DeviceInfo>;
+
+export { type AggregateFieldInput, type BatchInsertInput, type BatchUpdateInput, type DeleteByIdInput, type DeleteInput, type DeviceInfo, type InsertOneInput, type LoginInput, type LogoutDeviceInput, type LogoutInput, type QueryAggregateInput, type QueryByIdInput, type QueryInput, type QueryPageListInput, type RefreshTokenInput, type RegisterUserInput, type RequestConfig, type RequestInterceptor, type SendCodeInput, type UpdateByPkInput, type UpdateInput, type UserToken, type VerifyCodeInput, auth, clearHeaders, getBrowserDeviceInfo, getClient, getDeviceInfo, gql, initGraphQLClient, mutation, query, removeHeader, removeToken, type requestResult, setEndpoint, setHeader, setHeaders, setToken, sms, useInterceptor };

package/dist/index.d.ts

@@ -0,0 +1,300 @@
+import { DocumentNode } from 'graphql';
+
+interface RequestConfig {
+    endpoint?: string;
+    Authorization?: string;
+    headers?: Record<string, string>;
+    loginInfo?: UserToken | null | undefined;
+}
+/** 拦截器接口 */
+interface RequestInterceptor {
+    /** 请求发出前拦截，可修改 query、variables、headers */
+    onRequest?: (params: {
+        query: string;
+        variables?: Record<string, any>;
+        headers: Record<string, string | undefined> & {
+            "X-Device-Id"?: string;
+            "X-Device-Name"?: string;
+        };
+    }) => Promise<typeof params> | typeof params;
+    /** 响应成功拦截，可修改返回结构 */
+    onResponse?: (response: any) => Promise<any> | any;
+    /** 错误拦截，可做统一错误处理或重试 */
+    onError?: (error: any) => Promise<any> | any;
+}
+interface requestResult<T = any> {
+    [key: string]: T;
+}
+interface UserToken {
+    /** 用户 ID */
+    userId: number;
+    /** 登录账号 */
+    loginAccount: string;
+    /** 访问 Token */
+    token: string;
+    /** 刷新 Token */
+    refreshToken: string;
+    /** 访问 Token 过期时间 */
+    expireAt: string;
+    /** 刷新 Token 过期时间 */
+    refreshExpireAt: string;
+    /** 设备 ID */
+    deviceId?: string;
+    /** 设备名称 */
+    deviceName?: string;
+    /** 登录时间 */
+    loginTime?: string;
+    /** 登录 IP */
+    requestIp?: string;
+    /** 客户端信息 */
+    userAgent?: string;
+    /** 上次刷新时间 */
+    lastRefreshTime?: string;
+    /** 用户角色编码列表 */
+    roles: string[];
+    /** 用户权限编码列表 */
+    permissions: string[];
+}
+
+declare class CCRequest {
+    private config;
+    private client;
+    private headers;
+    private deviceInfoPromise;
+    private interceptors;
+    constructor(config: RequestConfig);
+    /** 注册一个拦截器（支持多个） */
+    use(interceptor: RequestInterceptor): void;
+    /** 构建 GraphQLClient 实例 */
+    private buildClient;
+    /** 构建初始 headers */
+    private buildHeaders;
+    setToken(token: string): void;
+    removeToken(): void;
+    setLoginInfo(loginInfo: UserToken, remember?: boolean): void;
+    /** 加载登录信息（含访问 token 和刷新 token 过期检查） */
+    /** 加载登录信息（仅负责加载，不负责刷新） */
+    loadLoginInfo(): UserToken | null;
+    getLoginInfo(): UserToken | null;
+    removeLoginInfo(): void;
+    setEndpoint(endpoint: string): void;
+    setHeader(key: string, value: string): void;
+    setHeaders(headers: Record<string, string>): void;
+    removeHeader(key: string): void;
+    clearHeaders(): void;
+    private ensureTokenValid;
+    request<T = any>(query: string | DocumentNode, variables?: Record<string, any>): Promise<T>;
+}
+
+/** 初始化全局客户端 */
+declare function initGraphQLClient(config: RequestConfig): CCRequest;
+/** 获取全局客户端实例 */
+declare function getClient(): CCRequest;
+/** 注册全局拦截器 */
+declare const useInterceptor: (interceptor: RequestInterceptor) => void;
+declare const setToken: (token: string) => void;
+declare const removeToken: () => void;
+declare const setEndpoint: (endpoint: string) => void;
+declare const setHeader: (key: string, value: string) => void;
+declare const setHeaders: (headers: Record<string, string>) => void;
+declare const removeHeader: (key: string) => void;
+declare const clearHeaders: () => void;
+
+type FieldInput = string | {
+    [key: string]: FieldNode;
+};
+interface FieldNode {
+    fields: FieldInput[];
+    where?: WhereInput;
+    orderBy?: Record<string, any>;
+    distinctOn?: string[];
+    limit?: number;
+    offset?: number;
+}
+interface WhereInput {
+    _and?: WhereInput[];
+    _or?: WhereInput[];
+    _not?: WhereInput;
+    [field: string]: any;
+}
+
+interface QueryInput {
+    operationName: string;
+    fields?: FieldInput[];
+    variables?: Record<string, any>;
+    where?: WhereInput;
+    orderBy?: Record<string, any>;
+    distinctOn?: string[];
+    limit?: number;
+    offset?: number;
+}
+interface QueryPageListInput {
+    operationName: string;
+    fields: FieldInput[];
+    variables?: Record<string, any>;
+    where?: WhereInput;
+    orderBy?: Record<string, any>;
+    distinctOn?: string[];
+    size?: number;
+    page?: number;
+}
+interface QueryByIdInput {
+    operationName: string;
+    fields: FieldInput[];
+    pk: string | number;
+}
+interface QueryAggregateInput {
+    operationName: string;
+    fields: FieldInput[];
+    aggregateFields?: AggregateFieldInput;
+    variables?: Record<string, any>;
+    where?: WhereInput;
+    distinctOn?: string[];
+}
+interface AggregateFieldInput {
+    count?: boolean;
+    sum?: string[];
+    avg?: string[];
+    max?: string[];
+    min?: string[];
+}
+
+interface InsertOneInput {
+    operationName: string;
+    fields: FieldInput[];
+    data: Record<string, any>;
+    variables?: Record<string, any>;
+}
+interface BatchInsertInput {
+    operationName: string;
+    fields: FieldInput[];
+    datas: Record<string, any>[];
+    variables?: Record<string, any>;
+}
+interface UpdateInput {
+    operationName: string;
+    fields: FieldInput[];
+    _set: Record<string, any>;
+    where: WhereInput;
+    variables?: Record<string, any>;
+}
+interface BatchUpdateInput {
+    operationName: string;
+    fields: FieldInput[];
+    _set: Record<string, any>[];
+    variables?: Record<string, any>;
+}
+interface UpdateByPkInput {
+    operationName: string;
+    fields: FieldInput[];
+    _set: Record<string, any>;
+    pk_columns: string | number;
+    variables?: Record<string, any>;
+}
+interface DeleteByIdInput {
+    operationName: string;
+    fields: FieldInput[];
+    pk_columns: string | number;
+    variables?: Record<string, any>;
+}
+interface DeleteInput {
+    operationName: string;
+    fields: FieldInput[];
+    where: WhereInput;
+    variables?: Record<string, any>;
+}
+
+interface SendCodeInput {
+    phone: string;
+    dataFields?: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface VerifyCodeInput {
+    code: string;
+    phone: string;
+    variables?: Record<string, any>;
+}
+
+interface LoginInput {
+    account: string;
+    password: string;
+    deviceId?: string;
+    variables?: Record<string, any>;
+    remember?: boolean;
+}
+interface RegisterUserInput {
+    user: Record<string, any>;
+    fields: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface LogoutInput {
+    dataFields?: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface LogoutDeviceInput {
+    deviceId: string;
+    dataFields?: FieldInput[];
+    variables?: Record<string, any>;
+}
+interface RefreshTokenInput {
+    refreshToken: string;
+    variables?: Record<string, any>;
+    remember?: boolean;
+}
+
+declare const auth: {
+    login<T = requestResult<UserToken>>(input: LoginInput): Promise<T>;
+    refreshToken<T = requestResult<UserToken>>(input: RefreshTokenInput): Promise<T>;
+    register<T = requestResult<any>>(input: RegisterUserInput): Promise<T>;
+    logout<T = requestResult<any>>(): Promise<T>;
+    logoutAllDevices<T = requestResult<any>>(): Promise<T>;
+    logoutDevice<T = requestResult<any>>(deviceId: string): Promise<T>;
+};
+
+declare const query: {
+    list<T = requestResult<any>>(input: QueryInput, useCache?: boolean, ttl?: number): Promise<T>;
+    byId<T = requestResult<any>>(input: QueryByIdInput, useCache?: boolean, ttl?: number): Promise<T>;
+    page<T = requestResult<any>>(input: QueryPageListInput, useCache?: boolean, ttl?: number): Promise<T>;
+    aggregate<T = requestResult<any>>(input: QueryAggregateInput, useCache?: boolean, ttl?: number): Promise<T>;
+};
+
+declare const mutation: {
+    insertOne<T = requestResult<any>>(input: InsertOneInput): Promise<T>;
+    batchInsert<T = requestResult<any>>(input: BatchInsertInput): Promise<T>;
+    update<T = requestResult<any>>(input: UpdateInput): Promise<T>;
+    batchUpdate<T = requestResult<any>>(input: BatchUpdateInput): Promise<T>;
+    updateByPk<T = requestResult<any>>(input: UpdateByPkInput): Promise<T>;
+    delete<T = requestResult<any>>(input: DeleteInput): Promise<T>;
+    deleteById<T = requestResult<any>>(input: DeleteByIdInput): Promise<T>;
+};
+
+declare const sms: {
+    send<T = requestResult<any>>(input: SendCodeInput): Promise<T>;
+    verify<T = requestResult<any>>(input: VerifyCodeInput): Promise<T>;
+};
+
+/**
+ * 原生 GraphQL 执行模块
+ * 可执行任意 query / mutation / subscription
+ */
+declare const gql: {
+    /**
+     * 执行任意 GraphQL 文本或 DocumentNode
+     * @param query 原生 GQL 文本或 DocumentNode
+     * @param variables 可选变量
+     * @returns Promise<T>
+     */
+    execute<T = requestResult<any>>(query: string | DocumentNode, variables?: Record<string, any>): Promise<T>;
+};
+
+interface DeviceInfo {
+    deviceId: string;
+    deviceName: string;
+    env: "node" | "browser";
+}
+/** 浏览器端设备信息 */
+declare function getBrowserDeviceInfo(): Promise<DeviceInfo>;
+/** 跨平台获取设备信息 */
+declare function getDeviceInfo(): Promise<DeviceInfo>;
+
+export { type AggregateFieldInput, type BatchInsertInput, type BatchUpdateInput, type DeleteByIdInput, type DeleteInput, type DeviceInfo, type InsertOneInput, type LoginInput, type LogoutDeviceInput, type LogoutInput, type QueryAggregateInput, type QueryByIdInput, type QueryInput, type QueryPageListInput, type RefreshTokenInput, type RegisterUserInput, type RequestConfig, type RequestInterceptor, type SendCodeInput, type UpdateByPkInput, type UpdateInput, type UserToken, type VerifyCodeInput, auth, clearHeaders, getBrowserDeviceInfo, getClient, getDeviceInfo, gql, initGraphQLClient, mutation, query, removeHeader, removeToken, type requestResult, setEndpoint, setHeader, setHeaders, setToken, sms, useInterceptor };