@ctil/gql 1.0.20 → 1.0.21

package/dist/index.d.ts

@@ -101,6 +101,7 @@ declare class CCRequest {
     /** 构建初始 headers */
     private buildHeaders;
     setToken(token: string): void;
+    getToken(): string;
     removeToken(): void;
     setLoginInfo(loginInfo: UserToken, remember?: boolean): void;
     /** 加载登录信息（仅负责加载，不负责刷新） */
@@ -109,8 +110,11 @@ declare class CCRequest {
     getLoginInfo(): UserToken | null;
     removeLoginInfo(): void;
     setEndpoint(endpoint: string): void;
+    getEndpoint(): string | undefined;
     setHeader(key: string, value: string): void;
+    getHeader(key: string): string;
     setHeaders(headers: Record<string, string>): void;
+    getHeaders(): Record<string, string>;
     removeHeader(key: string): void;
     clearHeaders(): void;
     /** 无感刷新 token */
@@ -126,9 +130,15 @@ declare function getClient(): CCRequest;
 declare const useInterceptor: (interceptor: RequestInterceptor) => void;
 declare const setToken: (token: string) => void;
 declare const removeToken: () => void;
+declare const getToken: () => string;
+declare const getLoginInfo: () => UserToken | null;
+declare const getLoginRoles: () => string[] | undefined;
 declare const setEndpoint: (endpoint: string) => void;
+declare const getEndpoint: () => string | undefined;
 declare const setHeader: (key: string, value: string) => void;
 declare const setHeaders: (headers: Record<string, string>) => void;
+declare const getHeaders: () => Record<string, string>;
+declare const getHeader: (key: string) => string;
 declare const removeHeader: (key: string) => void;
 declare const clearHeaders: () => void;
 
@@ -168,61 +178,6 @@ declare function generateOperationName(entityName: string, original: string): st
 declare function toPascalCase(str: string): string;
 declare function buildCommonResultSelection(dataFields?: FieldInput[]): string;
 
-declare const rateLimitConfig: {
-    defaultRules: {
-        query: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-        mutation: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-    };
-    custom: {
-        login: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-        refreshToken: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-    };
-};
-
-declare function setRateLimitConfig(newConfig: typeof rateLimitConfig): void;
-declare function getRateLimitConfig(): {
-    defaultRules: {
-        query: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-        mutation: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-    };
-    custom: {
-        login: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-        refreshToken: {
-            max: number;
-            window: number;
-            debounce: number;
-        };
-    };
-};
-
 interface QueryInput {
     operationName: string;
     fields?: FieldInput[];
@@ -263,6 +218,25 @@ interface AggregateFieldInput {
     max?: string[];
     min?: string[];
 }
+/** 生成完整 query，包括变量定义 */
+declare function buildGraphQLQueryList(input: QueryInput): {
+    query: string;
+    variables: Record<string, any> | undefined;
+};
+/** 生成按 ID 查询的 GraphQL query（固定主键参数名为 id） */
+declare function buildGraphQLQueryByIdFixed(queryByIdInput: QueryByIdInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成分页查询的输入 */
+declare function buildGraphQLQueryPageList(input: QueryPageListInput): {
+    query: string;
+    variables: Record<string, any> | undefined;
+};
+declare function buildGraphQLQueryAggregate(input: QueryAggregateInput): {
+    query: string;
+    variables: Record<string, any> | undefined;
+};
 
 interface InsertOneInput {
     operationName: string;
@@ -308,17 +282,64 @@ interface DeleteInput {
     where: WhereInput;
     variables?: Record<string, any>;
 }
+type MutationField = {
+    affected_rows?: boolean;
+    returning?: FieldInput[];
+};
+/** 生成单个插入的 GraphQL mutation */
+declare function buildGraphQLMutationInsertOne(input: InsertOneInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成批量插入的 GraphQL mutation */
+declare function buildGraphQLMutationBatchInsert(input: BatchInsertInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成根据条件更新的 GraphQL mutation */
+declare function buildGraphQLMutationUpdate(input: UpdateInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成批量更新的 GraphQL mutation（根据 ID） */
+declare function buildGraphQLMutationBatchUpdate(input: BatchUpdateInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成根据主键更新的 GraphQL mutation */
+declare function buildGraphQLMutationUpdateByPk(input: UpdateByPkInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成根据主键删除的 GraphQL mutation */
+declare function buildGraphQLMutationDeleteById(input: DeleteByIdInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+/** 生成根据条件删除的 GraphQL mutation */
+declare function buildGraphQLMutationDelete(input: DeleteInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 
 interface SendCodeInput {
     phone: string;
     dataFields?: FieldInput[];
     variables?: Record<string, any>;
 }
+declare function buildGraphQLMutationSendCode(input: SendCodeInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 interface VerifyCodeInput {
     code: string;
     phone: string;
     variables?: Record<string, any>;
 }
+declare function buildGraphQLMutationVerifyCode(input: VerifyCodeInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 
 interface LoginInput {
     account: string;
@@ -327,25 +348,49 @@ interface LoginInput {
     variables?: Record<string, any>;
     remember?: boolean;
 }
+declare function buildGraphQLMutationLogin(input: LoginInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 interface RegisterUserInput {
     user: Record<string, any>;
     fields: FieldInput[];
     variables?: Record<string, any>;
 }
+declare function buildGraphQLMutationRegisterUser(input: RegisterUserInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 interface LogoutInput {
     dataFields?: FieldInput[];
     variables?: Record<string, any>;
 }
+declare function buildGraphQLMutationLogout(input?: LogoutInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+declare function buildGraphQLMutationLogoutAllDevices(input?: LogoutInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 interface LogoutDeviceInput {
     deviceId: string;
     dataFields?: FieldInput[];
     variables?: Record<string, any>;
 }
+declare function buildGraphQLMutationLogoutDevice(input: LogoutDeviceInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 interface RefreshTokenInput {
     refreshToken: string;
     variables?: Record<string, any>;
     remember?: boolean;
 }
+declare function buildGraphQLMutationRefreshToken(input: RefreshTokenInput): {
+    query: string;
+    variables: Record<string, any>;
+};
 
 interface FilePreview {
     /** 资源ID，主键 */
@@ -359,6 +404,171 @@ interface FilePreview {
     /** 文件地址 */
     url: string;
 }
+interface PresignedUrlResult {
+    /** 上传预签名 URL（PUT/POST） */
+    uploadUrl: string;
+    /** 下载预签名 URL（可选，如果是 private 文件） */
+    downloadUrl?: string;
+    /** OSS 文件路径 */
+    objectKey: string;
+    /** 上传 URL 过期时间 */
+    expireAt?: string | Date;
+    /** Content-Type */
+    contentType?: string;
+    /** 原始文件名 */
+    originalFileName?: string;
+    /** resourceId，后台可能返回，便于直接绑定到实体 */
+    resourceId?: number | null;
+    /** 上传时需要设置的 HTTP Header */
+    uploadHeaders?: UploadHeaders;
+}
+interface UploadHeaders {
+    /** 文件 MD5，Base64 编码 */
+    contentMD5?: string;
+    /** 文件 Content-Type */
+    contentType?: string;
+    /** 文件 ACL: PRIVATE / PUBLIC_READ */
+    x_oss_object_acl?: string;
+    /** 请求时间戳（秒） */
+    date?: string;
+}
+interface UploadPresignedUrlInput {
+    /** 文件 base64 MD5 值，用于去重 */
+    fileMd5Base64: string;
+    /** 文件后缀，例如 "jpg", "png" */
+    fileSuffix: string;
+    /** 用户上传的原始文件名 */
+    originalFileName: string;
+    /** 一级目录，例如 "avatars" */
+    folder?: string;
+    /** 文件大小，单位字节 */
+    fileSize: number;
+    /** 文件访问权限: "private" | "public_read"，默认 private */
+    acl?: 'private' | 'public_read';
+}
+declare function buildGraphQLUploadPresignedUrl(input: UploadPresignedUrlInput): {
+    query: string;
+    variables: Record<string, any>;
+};
+declare function buildGraphQLGetFilePreview(resourceId: number | string): {
+    query: string;
+    variables: Record<string, any>;
+};
+
+type index_AggregateFieldInput = AggregateFieldInput;
+type index_BatchInsertInput = BatchInsertInput;
+type index_BatchUpdateInput = BatchUpdateInput;
+type index_DeleteByIdInput = DeleteByIdInput;
+type index_DeleteInput = DeleteInput;
+type index_FieldInput = FieldInput;
+type index_FieldNode = FieldNode;
+type index_FilePreview = FilePreview;
+type index_InsertOneInput = InsertOneInput;
+type index_LoginInput = LoginInput;
+type index_LogoutDeviceInput = LogoutDeviceInput;
+type index_LogoutInput = LogoutInput;
+type index_MutationField = MutationField;
+type index_PresignedUrlResult = PresignedUrlResult;
+type index_QueryAggregateInput = QueryAggregateInput;
+type index_QueryByIdInput = QueryByIdInput;
+type index_QueryInput = QueryInput;
+type index_QueryPageListInput = QueryPageListInput;
+type index_RefreshTokenInput = RefreshTokenInput;
+type index_RegisterUserInput = RegisterUserInput;
+type index_SendCodeInput = SendCodeInput;
+type index_UpdateByPkInput = UpdateByPkInput;
+type index_UpdateInput = UpdateInput;
+type index_UploadHeaders = UploadHeaders;
+type index_UploadPresignedUrlInput = UploadPresignedUrlInput;
+type index_VerifyCodeInput = VerifyCodeInput;
+type index_WhereInput = WhereInput;
+declare const index_buildCommonResultSelection: typeof buildCommonResultSelection;
+declare const index_buildDataValue: typeof buildDataValue;
+declare const index_buildFields: typeof buildFields;
+declare const index_buildGraphQLGetFilePreview: typeof buildGraphQLGetFilePreview;
+declare const index_buildGraphQLMutationBatchInsert: typeof buildGraphQLMutationBatchInsert;
+declare const index_buildGraphQLMutationBatchUpdate: typeof buildGraphQLMutationBatchUpdate;
+declare const index_buildGraphQLMutationDelete: typeof buildGraphQLMutationDelete;
+declare const index_buildGraphQLMutationDeleteById: typeof buildGraphQLMutationDeleteById;
+declare const index_buildGraphQLMutationInsertOne: typeof buildGraphQLMutationInsertOne;
+declare const index_buildGraphQLMutationLogin: typeof buildGraphQLMutationLogin;
+declare const index_buildGraphQLMutationLogout: typeof buildGraphQLMutationLogout;
+declare const index_buildGraphQLMutationLogoutAllDevices: typeof buildGraphQLMutationLogoutAllDevices;
+declare const index_buildGraphQLMutationLogoutDevice: typeof buildGraphQLMutationLogoutDevice;
+declare const index_buildGraphQLMutationRefreshToken: typeof buildGraphQLMutationRefreshToken;
+declare const index_buildGraphQLMutationRegisterUser: typeof buildGraphQLMutationRegisterUser;
+declare const index_buildGraphQLMutationSendCode: typeof buildGraphQLMutationSendCode;
+declare const index_buildGraphQLMutationUpdate: typeof buildGraphQLMutationUpdate;
+declare const index_buildGraphQLMutationUpdateByPk: typeof buildGraphQLMutationUpdateByPk;
+declare const index_buildGraphQLMutationVerifyCode: typeof buildGraphQLMutationVerifyCode;
+declare const index_buildGraphQLQueryAggregate: typeof buildGraphQLQueryAggregate;
+declare const index_buildGraphQLQueryByIdFixed: typeof buildGraphQLQueryByIdFixed;
+declare const index_buildGraphQLQueryList: typeof buildGraphQLQueryList;
+declare const index_buildGraphQLQueryPageList: typeof buildGraphQLQueryPageList;
+declare const index_buildGraphQLUploadPresignedUrl: typeof buildGraphQLUploadPresignedUrl;
+declare const index_buildMutationFields: typeof buildMutationFields;
+declare const index_buildWhere: typeof buildWhere;
+declare const index_formatGraphQLValue: typeof formatGraphQLValue;
+declare const index_generateOperationName: typeof generateOperationName;
+declare const index_toPascalCase: typeof toPascalCase;
+declare namespace index {
+  export { type index_AggregateFieldInput as AggregateFieldInput, type index_BatchInsertInput as BatchInsertInput, type index_BatchUpdateInput as BatchUpdateInput, type index_DeleteByIdInput as DeleteByIdInput, type index_DeleteInput as DeleteInput, type index_FieldInput as FieldInput, type index_FieldNode as FieldNode, type index_FilePreview as FilePreview, type index_InsertOneInput as InsertOneInput, type index_LoginInput as LoginInput, type index_LogoutDeviceInput as LogoutDeviceInput, type index_LogoutInput as LogoutInput, type index_MutationField as MutationField, type index_PresignedUrlResult as PresignedUrlResult, type index_QueryAggregateInput as QueryAggregateInput, type index_QueryByIdInput as QueryByIdInput, type index_QueryInput as QueryInput, type index_QueryPageListInput as QueryPageListInput, type index_RefreshTokenInput as RefreshTokenInput, type index_RegisterUserInput as RegisterUserInput, type index_SendCodeInput as SendCodeInput, type index_UpdateByPkInput as UpdateByPkInput, type index_UpdateInput as UpdateInput, type index_UploadHeaders as UploadHeaders, type index_UploadPresignedUrlInput as UploadPresignedUrlInput, type index_VerifyCodeInput as VerifyCodeInput, type index_WhereInput as WhereInput, index_buildCommonResultSelection as buildCommonResultSelection, index_buildDataValue as buildDataValue, index_buildFields as buildFields, index_buildGraphQLGetFilePreview as buildGraphQLGetFilePreview, index_buildGraphQLMutationBatchInsert as buildGraphQLMutationBatchInsert, index_buildGraphQLMutationBatchUpdate as buildGraphQLMutationBatchUpdate, index_buildGraphQLMutationDelete as buildGraphQLMutationDelete, index_buildGraphQLMutationDeleteById as buildGraphQLMutationDeleteById, index_buildGraphQLMutationInsertOne as buildGraphQLMutationInsertOne, index_buildGraphQLMutationLogin as buildGraphQLMutationLogin, index_buildGraphQLMutationLogout as buildGraphQLMutationLogout, index_buildGraphQLMutationLogoutAllDevices as buildGraphQLMutationLogoutAllDevices, index_buildGraphQLMutationLogoutDevice as buildGraphQLMutationLogoutDevice, index_buildGraphQLMutationRefreshToken as buildGraphQLMutationRefreshToken, index_buildGraphQLMutationRegisterUser as buildGraphQLMutationRegisterUser, index_buildGraphQLMutationSendCode as buildGraphQLMutationSendCode, index_buildGraphQLMutationUpdate as buildGraphQLMutationUpdate, index_buildGraphQLMutationUpdateByPk as buildGraphQLMutationUpdateByPk, index_buildGraphQLMutationVerifyCode as buildGraphQLMutationVerifyCode, index_buildGraphQLQueryAggregate as buildGraphQLQueryAggregate, index_buildGraphQLQueryByIdFixed as buildGraphQLQueryByIdFixed, index_buildGraphQLQueryList as buildGraphQLQueryList, index_buildGraphQLQueryPageList as buildGraphQLQueryPageList, index_buildGraphQLUploadPresignedUrl as buildGraphQLUploadPresignedUrl, index_buildMutationFields as buildMutationFields, index_buildWhere as buildWhere, index_formatGraphQLValue as formatGraphQLValue, index_generateOperationName as generateOperationName, index_toPascalCase as toPascalCase };
+}
+
+declare const rateLimitConfig: {
+    defaultRules: {
+        query: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+        mutation: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+    };
+    custom: {
+        login: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+        refreshToken: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+    };
+};
+
+declare function setRateLimitConfig(newConfig: typeof rateLimitConfig): void;
+declare function getRateLimitConfig(): {
+    defaultRules: {
+        query: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+        mutation: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+    };
+    custom: {
+        login: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+        refreshToken: {
+            max: number;
+            window: number;
+            debounce: number;
+        };
+    };
+};
 
 declare const auth: {
     login<T = requestResult<UserToken>>(input: LoginInput): Promise<T>;
@@ -444,4 +654,75 @@ declare function getBrowserDeviceInfo(): Promise<DeviceInfo>;
 /** 跨平台获取设备信息 */
 declare function getDeviceInfo(): Promise<DeviceInfo>;
 
-export { type AggregateFieldInput, type BatchInsertInput, type BatchUpdateInput, type DeleteByIdInput, type DeleteInput, type DeviceInfo, type FieldInput, type FieldNode, 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, type WhereInput, auth, buildCommonResultSelection, buildDataValue, buildFields, buildMutationFields, buildWhere, clearHeaders, formatGraphQLValue, generateOperationName, getBrowserDeviceInfo, getClient, getDeviceInfo, getRateLimitConfig, gql, initGraphQLClient, mutation, oss, query, type rateLimitConfig$1 as rateLimitConfig, removeHeader, removeToken, type requestResult, setEndpoint, setHeader, setHeaders, setRateLimitConfig, setToken, sms, toPascalCase, useInterceptor };
+declare function formatDate(date: Date | string, format?: string): string;
+declare function getStartOfDay(date?: Date): Date;
+declare function getEndOfDay(date?: Date): Date;
+declare function getStartOfWeek(date?: Date): Date;
+declare function getEndOfWeek(date?: Date): Date;
+declare function getStartOfMonth(date?: Date): Date;
+declare function getEndOfMonth(date?: Date): Date;
+declare function isLeapYear(year: number): boolean;
+declare function diffDays(date1: Date, date2: Date): number;
+declare function addDays(date: Date, n: number): Date;
+declare function secondsToTime(sec: number): string;
+declare function fromNow(date: Date | string): string;
+
+declare function deepClone<T>(obj: T): T;
+declare function merge<T, U>(obj1: T, obj2: U): T & U;
+declare function isEmptyObject(obj: object): boolean;
+declare function pick<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+declare function get(obj: any, path: string, def?: any): any;
+declare function set(obj: any, path: string, value: any): any;
+declare function isEqual(a: any, b: any): boolean;
+declare function flatten(obj: any, prefix?: string, res?: Record<string, any>): Record<string, any>;
+declare function unflatten(obj: Record<string, any>): any;
+
+declare function unique<T>(arr: T[]): T[];
+declare function intersection<T>(arr1: T[], arr2: T[]): T[];
+declare function union<T>(arr1: T[], arr2: T[]): T[];
+declare function groupBy<T, K extends keyof T>(arr: T[], key: K): Record<string, T[]>;
+declare function difference<T>(arr1: T[], arr2: T[]): T[];
+
+declare function formatMoney(num: number | string): string;
+declare function add(a: number, b: number): number;
+declare function subtract(a: number, b: number): number;
+declare function multiply(a: number, b: number): number;
+declare function divide(a: number, b: number): number;
+declare function roundWithPrecision(num: number, precision?: number): number;
+declare function randomInt(min: number, max: number): number;
+declare function toFixed(num: number, precision?: number): string;
+declare function toPercent(num: number, total: number, precision?: number): string;
+declare function toNonExponential(num: number): string;
+declare function inRange(num: number, min: number, max: number): boolean;
+declare function toNumber(val: any): number;
+declare function ceil(num: number): number;
+declare function floor(num: number): number;
+declare function round(num: number): number;
+
+declare function toSnakeCase(str: string): string;
+declare function capitalize(str: string): string;
+declare function truncate(str: string, length: number, suffix?: string): string;
+declare function removeAllSpace(str: string): string;
+declare function trim(str: string): string;
+declare function toCamelCase(str: string): string;
+declare function kebabToCamel(str: string): string;
+declare function uncapitalize(str: string): string;
+declare function reverse(str: string): string;
+declare function isNumeric(str: string): boolean;
+declare function isEmail(str: string): boolean;
+declare function countSubstr(str: string, sub: string): number;
+declare function randomString(len?: number): string;
+
+declare function base64Encode(input: string): string;
+declare function base64Decode(input: string): string;
+declare function hashCode(str: string): number;
+declare function md5(str: string): string;
+declare function simpleSHA1(str: string): string;
+
+declare function getExtName(filename: string): string;
+declare function formatSize(bytes: number): string;
+declare function fileToBase64(file: File | Blob): Promise<string>;
+declare function base64ToFile(dataurl: string, filename: string, mimeType?: string): File;
+
+export { type AggregateFieldInput, type BatchInsertInput, type BatchUpdateInput, type DeleteByIdInput, type DeleteInput, type DeviceInfo, type FieldInput, type FieldNode, 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, type WhereInput, add, addDays, auth, base64Decode, base64Encode, base64ToFile, capitalize, ceil, clearHeaders, countSubstr, deepClone, diffDays, difference, divide, fileToBase64, flatten, floor, formatDate, formatMoney, formatSize, fromNow, get, getBrowserDeviceInfo, getClient, getDeviceInfo, getEndOfDay, getEndOfMonth, getEndOfWeek, getEndpoint, getExtName, getHeader, getHeaders, getLoginInfo, getLoginRoles, getRateLimitConfig, getStartOfDay, getStartOfMonth, getStartOfWeek, getToken, gql, index as gqlBuilder, groupBy, hashCode, inRange, initGraphQLClient, intersection, isEmail, isEmptyObject, isEqual, isLeapYear, isNumeric, kebabToCamel, md5, merge, multiply, mutation, omit, oss, pick, query, randomInt, randomString, type rateLimitConfig$1 as rateLimitConfig, removeAllSpace, removeHeader, removeToken, type requestResult, reverse, round, roundWithPrecision, secondsToTime, set, setEndpoint, setHeader, setHeaders, setRateLimitConfig, setToken, simpleSHA1, sms, subtract, toCamelCase, toFixed, toNonExponential, toNumber, toPercent, toSnakeCase, trim, truncate, uncapitalize, unflatten, union, unique, useInterceptor };