@cloudcome/utils-uni 1.37.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloud/types.d.ts +1 -10
- package/dist/cloud.cjs.map +1 -1
- package/dist/cloud.mjs.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
package/dist/cloud/types.d.ts
CHANGED
|
@@ -152,11 +152,7 @@ export type CloudModuleOutput<T> = UniErrorData & T;
|
|
|
152
152
|
* @param input 输入参数
|
|
153
153
|
* @returns 返回包含输出数据的Promise
|
|
154
154
|
*/
|
|
155
|
-
export type CloudMethod<I, O> = (
|
|
156
|
-
/** 云对象上下文 */
|
|
157
|
-
this: CloudObjectThis,
|
|
158
|
-
/** 输入参数 */
|
|
159
|
-
input: I) => Promise<CloudMethodOutput<O>>;
|
|
155
|
+
export type CloudMethod<I, O> = (input: I) => Promise<CloudMethodOutput<O>>;
|
|
160
156
|
/**
|
|
161
157
|
* 提取云对象方法输入参数类型
|
|
162
158
|
* 用于从 UniCloudExpose<I, O> 中提取输入参数类型 I
|
|
@@ -167,8 +163,3 @@ export type ExtractCloudMethodInput<T> = T extends CloudMethod<infer I, infer _O
|
|
|
167
163
|
* 用于从 UniCloudExpose<I, O> 中提取输出数据类型 O
|
|
168
164
|
*/
|
|
169
165
|
export type ExtractCloudMethodData<T> = T extends CloudMethod<infer _I, infer O> ? O : never;
|
|
170
|
-
/**
|
|
171
|
-
* 提取云对象方法请求签名类型
|
|
172
|
-
* 用于从 UniCloudExpose<I, O> 中提取函数签名 (input: I) => O
|
|
173
|
-
*/
|
|
174
|
-
export type ExtractCloudMethodRequest<T> = T extends CloudMethod<infer I, infer O> ? (input: I) => Promise<CloudMethodOutput<O>> : never;
|
package/dist/cloud.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cloud.cjs","names":[],"sources":["../src/cloud/error.ts","../src/cloud/module.ts","../src/cloud/respond.ts","../src/cloud/method.ts","../src/cloud/request.ts"],"sourcesContent":["import { errorAssign } from '@cloudcome/utils-core/error';\n\nexport function createCloudObjectError(message: string, code?: number | string) {\n return errorAssign(new Error(message), {\n errCode: code,\n errMsg: message,\n });\n}\n","import { objectOmit } from '@cloudcome/utils-core/object';\nimport { createCloudObjectError } from './error';\nimport type { CloudModuleOutput } from './types';\n\n/**\n * 解析云模块输出结果\n *\n * 该函数用于处理云模块的输出,如果输出中包含错误码,则抛出相应的错误;\n * 否则返回去除错误码和错误信息后的数据部分。\n *\n * @template O - 输出数据的类型\n * @param output - 云模块的输出结果,包含errCode、errMsg和数据部分\n * @param fallbackErrorMessage - 当输出中没有错误信息时使用的默认错误消息\n * @returns 返回去除errCode和errMsg字段后的数据对象\n * @throws {CloudObjectError} 当output中存在errCode时抛出包含错误码和错误信息的异常\n *\n * @example\n * // 成功情况\n * const result = parseCloudModuleOutput({ value: 'success', errCode: 0, errMsg: '' });\n * // 返回: { value: 'success' }\n *\n * @example\n * // 错误情况\n * try {\n * parseCloudModuleOutput({ errCode: 404, errMsg: 'Not Found' });\n * } catch (error) {\n * // 抛出错误: CloudObjectError('Not Found', 404)\n * }\n */\nexport function parseCloudModuleOutput<O>(\n output: CloudModuleOutput<O>,\n fallbackErrorMessage = '',\n): Omit<O, 'errCode' | 'errMsg'> {\n if (output.errCode) {\n throw createCloudObjectError(output.errMsg || fallbackErrorMessage, output.errCode);\n }\n return objectOmit(output, ['errCode', 'errMsg']);\n}\n","import { errorNormalize } from '@cloudcome/utils-core/error';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport type { UniError } from '@/_types';\nimport type { CloudMethodOutput } from './types';\n\n/**\n * 执行云对象方法并标准化响应格式\n *\n * @template O - 函数返回值的类型\n * @param fn - 要执行的异步函数\n * @param append - 要附加到响应中的额外数据\n * @returns 标准化的云对象响应对象\n *\n * @example\n * ```typescript\n * const result = await respondCloudMethod(async () => {\n * return await getData();\n * }, { extra: 'data' });\n * ```\n */\nexport async function respondCloudMethod<O>(\n fn: () => MaybePromise<O>,\n append?: AnyObject,\n): Promise<CloudMethodOutput<O>> {\n try {\n const data = await fn();\n\n return {\n errCode: 0,\n errMsg: '',\n data,\n ...append,\n };\n } catch (err) {\n console.error('respondCloudObject error');\n console.error(err);\n\n const err2 = errorNormalize(err as UniError);\n\n return {\n errCode: err2.errCode || -1,\n errMsg: err2.errMsg || err2.message || '',\n // @ts-expect-error\n data: null,\n ...append,\n };\n }\n}\n","import { objectDefaults } from '@cloudcome/utils-core/object';\nimport { tryFlatten } from '@cloudcome/utils-core/try';\nimport { isFunction } from '@cloudcome/utils-core/type';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport { versionCompare } from '@cloudcome/utils-core/version';\nimport type z from 'zod';\nimport type { ZodObject } from 'zod';\nimport { createCloudObjectError } from './error';\nimport { parseCloudModuleOutput } from './module';\nimport { respondCloudMethod } from './respond';\nimport type { CloudMethod, CloudObjectThis } from './types';\nimport type { UniIdCommonModule } from './uni-id';\n\ntype _CloudObjectThisAppendUser = {\n id: string;\n role: string[];\n permission: string[];\n isAdmin: boolean;\n};\n\ntype _CloudObjectThisAppend = {\n options: Required<CreateCloudObjectOptions>;\n user: _CloudObjectThisAppendUser;\n};\n\nexport type CloudObjectContext = CloudObjectThis & _CloudObjectThisAppend;\n\nexport type BuildCloudMethodCreatorOptions = {\n /**\n * UniId 通用模块\n * 用于处理用户身份验证和权限管理\n * 如果提供,将在云对象执行前验证用户身份\n */\n uniIdCommonModule?: UniIdCommonModule;\n\n /**\n * 需要用户登录态的错误码\n * @default 'uni-id-check-token-failed'\n */\n requiredUserErrCode?: number | string;\n\n /**\n * 需要用户登录态的错误消息\n * @default '需要登录后才能进行此操作'\n */\n requiredUserErrMsg?: string;\n\n /**\n * 仅允许本地环境运行的错误消息\n * @default '运行环境不匹配'\n */\n onlyLocalEnvErrMsg?: string;\n\n /**\n * 版本不匹配错误消息\n * @default '应用版本过低'\n */\n appVersionTooLowErrMsg?: string;\n\n /**\n * 应用版本过高错误消息\n * @default '应用版本过高'\n */\n appVersionTooHighErrMsg?: string;\n\n /**\n * 响应附加数据函数\n * 用于在云对象响应中添加额外的上下文信息\n * @param objectThis 云对象上下文\n * @returns 返回要附加到响应中的数据对象\n */\n respondAppend?: (objectThis: CloudObjectThis) => AnyObject;\n\n /**\n * 所有云对象执行前钩子函数\n * @param context 云对象上下文,包含用户信息、选项等\n */\n onBefore?: (context: CloudObjectContext) => MaybePromise<unknown>;\n};\n\nexport type CreateCloudObjectOptions = {\n /**\n * 是否需要用户登录态\n * @default false\n */\n requiredUser?: boolean;\n\n /**\n * 是否仅在本地环境运行\n * @default false\n */\n onlyLocalEnv?: boolean;\n\n /**\n * 最小支持版本\n */\n minVersion?: string;\n\n /**\n * 最大支持版本\n */\n maxVersion?: string;\n\n /**\n * 非响应模式,常用于钩子函数中,如 _before, _after 等,\n * 文档:https://doc.dcloud.net.cn/uniCloud/cloud-obj.html#before-and-after\n */\n noRespond?: boolean;\n};\n\n/**\n * 云对象方法创建器类型定义\n *\n * 用于定义云对象方法的创建函数类型,支持两种重载形式:\n * 1. 带输入验证的版本:接收schema、处理函数和选项\n * 2. 无输入参数的版本:仅接收处理函数和选项\n */\nexport type CreateCloudMethod = {\n /**\n * 带输入验证的云对象方法创建器\n * @template S - Zod验证模式类型\n * @template O - 返回值类型\n * @param schema - Zod验证模式,用于验证输入数据\n * @param fn - 业务逻辑处理函数,接收上下文和验证后的输入数据\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <S extends ZodObject, O>(\n schema: S,\n fn: (context: CloudObjectContext, input: z.infer<S>) => MaybePromise<O>,\n options?: CreateCloudObjectOptions,\n ): CloudMethod<z.infer<S>, O>;\n\n /**\n * 无输入参数的云对象方法创建器\n * @template O - 返回值类型\n * @param fn - 业务逻辑处理函数,仅接收上下文\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <O>(fn: (context: CloudObjectContext) => MaybePromise<O>, options?: CreateCloudObjectOptions): CloudMethod<void, O>;\n};\n\n/**\n * 构建云对象方法创建器\n *\n * 该函数用于创建云对象方法的工厂函数,支持输入验证、用户身份验证、环境检查等功能。\n * 返回的创建器函数可以根据不同的配置创建云对象方法。\n *\n * @param options 构建选项,用于配置云对象方法创建器的行为\n * @returns 返回一个云对象方法创建器函数\n *\n * @example\n * // 创建一个需要用户登录的云对象方法\n * const createMethod = buildCloudMethodCreator({ uniIdCommonModule });\n * const myMethod = createMethod(async (context) => {\n * return { message: 'Hello ' + context.user.id };\n * }, { requiredUser: true });\n */\nexport function buildCloudMethodCreator(options?: BuildCloudMethodCreatorOptions) {\n const buildOptions = objectDefaults(options || {}, {\n requiredUserErrCode: 'uni-id-check-token-failed',\n requiredUserErrMsg: '需要登录后才能进行此操作',\n onlyLocalEnvErrMsg: '运行环境不匹配',\n appVersionTooLowErrMsg: '应用版本过低',\n appVersionTooHighErrMsg: '应用版本过高',\n respondAppend: () => ({}),\n onBefore: () => {},\n }) as Required<BuildCloudMethodCreatorOptions>;\n\n // @ts-expect-error\n const createCloudMethod: CreateCloudMethod = (arg0, arg1, arg2) => {\n // 确定选项来源:如果arg0是函数,则选项在arg1;否则在arg2\n const optionsSource = (isFunction(arg0) ? arg1 : arg2) as CreateCloudObjectOptions | undefined;\n\n // 设置默认选项值\n const createOptions = objectDefaults(optionsSource || {}, {\n requiredUser: false,\n onlyLocalEnv: false,\n }) as Required<CreateCloudObjectOptions>;\n\n return async function (input) {\n const cloudMethod = async () => {\n const { runtimeEnv } = this.getCloudInfo();\n\n if (createOptions.onlyLocalEnv && runtimeEnv !== 'local') {\n throw createCloudObjectError(buildOptions.onlyLocalEnvErrMsg);\n }\n\n const { appVersion } = this.getClientInfo();\n\n if (createOptions.minVersion && versionCompare(appVersion, createOptions.minVersion) < 0) {\n throw createCloudObjectError(buildOptions.appVersionTooLowErrMsg);\n }\n\n if (createOptions.maxVersion && versionCompare(appVersion, createOptions.maxVersion) > 0) {\n throw createCloudObjectError(buildOptions.appVersionTooHighErrMsg);\n }\n\n // 构建附加的上下文信息,包括用户身份和权限信息\n const user = await _parseAppendUser(this, options?.uniIdCommonModule);\n const append: _CloudObjectThisAppend = {\n options: createOptions,\n user: user,\n };\n const context = Object.assign(this, append) as CloudObjectContext;\n\n // 如果需要用户登录态但用户未登录,则抛出错误\n if (createOptions.requiredUser && !user.id) {\n throw createCloudObjectError(buildOptions.requiredUserErrMsg, buildOptions.requiredUserErrCode);\n }\n\n // 执行前钩子函数\n await buildOptions.onBefore(context);\n\n // 无入参函数调用\n if (isFunction(arg0)) {\n return await arg0(context);\n }\n\n // 有入参函数调用 - 验证输入数据\n const parsed = arg0.safeParse(input);\n\n // 输入验证失败处理\n if (!parsed.success) {\n console.log(parsed.error.issues);\n\n const issue0 = parsed.error?.issues?.[0];\n\n // 处理自定义验证错误\n if (issue0?.code === 'custom') throw issue0.message;\n throw new Error('请求数据不正确');\n }\n\n // 执行业务逻辑函数,传入上下文和验证后的数据\n return await arg1(context, parsed.data);\n };\n\n // 如果设置了非响应模式,则直接执行方法,不返回响应\n if (createOptions.noRespond) {\n return await cloudMethod();\n }\n\n // 处理云对象方法响应逻辑,包括错误捕获和统一响应格式\n return await respondCloudMethod(cloudMethod, buildOptions.respondAppend(this));\n };\n };\n\n return createCloudMethod;\n}\n\n/**\n * 解析并附加用户信息到云对象上下文\n *\n * 该函数用于验证用户身份并获取用户权限信息,将结果附加到云对象上下文中的user字段\n * 如果未提供uniIdCommonModule或验证失败,则返回默认的空用户信息\n *\n * @param objectThis 云对象上下文,包含客户端信息和token等\n * @param uniIdCommonModule 可选的UniId通用模块实例,用于验证用户token\n * @returns 返回包含用户ID、角色、权限等信息的对象\n *\n * @example\n * // 成功验证用户身份\n * const user = await _parseAppendUser(this, uniIdModule);\n * // 返回: { id: 'user123', role: ['user'], permission: ['read'], isAdmin: false }\n *\n * @example\n * // 验证失败或未提供模块\n * const user = await _parseAppendUser(this);\n * // 返回: { id: '', role: [], permission: [], isAdmin: false }\n */\nasync function _parseAppendUser(\n objectThis: CloudObjectThis,\n uniIdCommonModule?: UniIdCommonModule,\n): Promise<_CloudObjectThisAppendUser> {\n const appendUser: _CloudObjectThisAppendUser = {\n id: '',\n role: [],\n permission: [],\n isAdmin: false,\n };\n\n if (!uniIdCommonModule) return appendUser;\n\n const uic = uniIdCommonModule.createInstance({\n clientInfo: objectThis.getClientInfo(),\n });\n\n // 验证用户token,忽略验证过程中的错误\n const [_err1, user] = await tryFlatten(uic.checkToken(objectThis.getUniIdToken() || ''));\n if (!user) return appendUser;\n\n // 解析验证结果,忽略解析过程中的错误\n const [_err2, userData] = tryFlatten(() => parseCloudModuleOutput(user));\n if (!userData) return appendUser;\n\n appendUser.id = userData.uid || '';\n appendUser.role = userData.role || [];\n appendUser.permission = userData.permission || [];\n appendUser.isAdmin = appendUser.role.includes('admin') && appendUser.permission.length === 0;\n\n return appendUser;\n}\n","import { qsStringify } from '@cloudcome/utils-core/qs';\nimport type { AnyObject } from '@cloudcome/utils-core/types';\n\n/**\n * HTTP 请求配置选项\n */\nexport type RequestOptions = {\n /**\n * 请求 URL 地址\n */\n url: string;\n\n /**\n * URL 查询参数,会自动拼接到 url 后面\n */\n query?: Record<string, string>;\n\n /**\n * HTTP 请求方法\n * @default 'GET'\n */\n method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS';\n\n /**\n * 请求头\n */\n headers?: Record<string, string>;\n\n /**\n * 请求体数据\n */\n data?: AnyObject;\n\n /**\n * 返回数据格式\n * @default 'json'\n */\n dataType?: string;\n\n /**\n * 请求内容类型\n * - 'json': application/json\n * - 'form': application/x-www-form-urlencoded\n * @default 'json'\n */\n contentType?: string;\n\n /**\n * 请求超时时间,单位毫秒\n * @default 10000\n */\n timeout?: number;\n};\n\n/**\n * 发起 HTTP 请求\n *\n * 基于 uniCloud.httpclient 发起 HTTP 请求,支持 GET、POST、PUT、DELETE 等方法。\n * 查询参数会自动通过 qsStringify 拼接到 URL 上。\n *\n * @template T - 响应数据的类型\n * @param options 请求配置选项\n * @returns 包含 data、status、headers 的响应对象\n *\n * @example\n * ```ts\n * // GET 请求\n * const res = await request<{ name: string }>({\n * url: 'https://api.example.com/users/1',\n * })\n * console.log(res.data) // { name: 'Alice' }\n * console.log(res.status) // 200\n *\n * // POST 请求\n * const res = await request<{ id: string }>({\n * url: 'https://api.example.com/users',\n * method: 'POST',\n * data: { name: 'Alice', age: 25 },\n * })\n *\n * // 带查询参数\n * const res = await request<{ list: any[] }>({\n * url: 'https://api.example.com/users',\n * query: { page: '1', size: '10' },\n * })\n * ```\n */\nexport async function request<T>(options: RequestOptions) {\n const {\n url,\n query = {},\n method = 'GET',\n headers = {},\n data,\n dataType = 'json',\n contentType = 'json',\n timeout = 10000,\n } = options;\n\n const fullUrl = `${url}?${qsStringify(query)}`;\n\n // 使用uniCloud.httpclient发起请求\n // @ts-expect-error: uniCloud类型定义中可能缺少httpclient属性\n const res = await uniCloud.httpclient.request(fullUrl, {\n method,\n headers,\n data,\n dataType,\n contentType,\n timeout,\n });\n\n return res as { data: T; status: number; headers: Record<string, string> };\n}\n"],"mappings":";;;;;;;;;AAEA,SAAgB,uBAAuB,SAAiB,MAAwB;CAC9E,QAAA,GAAA,4BAAA,aAAmB,IAAI,MAAM,QAAQ,EAAE;EACrC,SAAS;EACT,QAAQ;EACT,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACuBJ,SAAgB,uBACd,QACA,uBAAuB,IACQ;CAC/B,IAAI,OAAO,SACT,MAAM,uBAAuB,OAAO,UAAU,sBAAsB,OAAO,QAAQ;CAErF,QAAA,GAAA,6BAAA,YAAkB,QAAQ,CAAC,WAAW,SAAS,CAAC;;;;;;;;;;;;;;;;;;;AChBlD,eAAsB,mBACpB,IACA,QAC+B;CAC/B,IAAI;EAGF,OAAO;GACL,SAAS;GACT,QAAQ;GACR,MAAA,MALiB,IAAI;GAMrB,GAAG;GACJ;UACM,KAAK;EACZ,QAAQ,MAAM,2BAA2B;EACzC,QAAQ,MAAM,IAAI;EAElB,MAAM,QAAA,GAAA,4BAAA,gBAAsB,IAAgB;EAE5C,OAAO;GACL,SAAS,KAAK,WAAW;GACzB,QAAQ,KAAK,UAAU,KAAK,WAAW;GAEvC,MAAM;GACN,GAAG;GACJ;;;;;;;;;;;;;;;;;;;;;ACkHL,SAAgB,wBAAwB,SAA0C;CAChF,MAAM,gBAAA,GAAA,6BAAA,gBAA8B,WAAW,EAAE,EAAE;EACjD,qBAAqB;EACrB,oBAAoB;EACpB,oBAAoB;EACpB,wBAAwB;EACxB,yBAAyB;EACzB,sBAAsB,EAAE;EACxB,gBAAgB;EACjB,CAAC;CAGF,MAAM,qBAAwC,MAAM,MAAM,SAAS;EAKjE,MAAM,iBAAA,GAAA,6BAAA,kBAAA,GAAA,2BAAA,YAH4B,KAAK,GAAG,OAAO,SAGK,EAAE,EAAE;GACxD,cAAc;GACd,cAAc;GACf,CAAC;EAEF,OAAO,eAAgB,OAAO;GAC5B,MAAM,cAAc,YAAY;IAC9B,MAAM,EAAE,eAAe,KAAK,cAAc;IAE1C,IAAI,cAAc,gBAAgB,eAAe,SAC/C,MAAM,uBAAuB,aAAa,mBAAmB;IAG/D,MAAM,EAAE,eAAe,KAAK,eAAe;IAE3C,IAAI,cAAc,eAAA,GAAA,8BAAA,gBAA6B,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,uBAAuB;IAGnE,IAAI,cAAc,eAAA,GAAA,8BAAA,gBAA6B,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,wBAAwB;IAIpE,MAAM,OAAO,MAAM,iBAAiB,MAAM,SAAS,kBAAkB;IACrE,MAAM,SAAiC;KACrC,SAAS;KACH;KACP;IACD,MAAM,UAAU,OAAO,OAAO,MAAM,OAAO;IAG3C,IAAI,cAAc,gBAAgB,CAAC,KAAK,IACtC,MAAM,uBAAuB,aAAa,oBAAoB,aAAa,oBAAoB;IAIjG,MAAM,aAAa,SAAS,QAAQ;IAGpC,KAAA,GAAA,2BAAA,YAAe,KAAK,EAClB,OAAO,MAAM,KAAK,QAAQ;IAI5B,MAAM,SAAS,KAAK,UAAU,MAAM;IAGpC,IAAI,CAAC,OAAO,SAAS;KACnB,QAAQ,IAAI,OAAO,MAAM,OAAO;KAEhC,MAAM,SAAS,OAAO,OAAO,SAAS;KAGtC,IAAI,QAAQ,SAAS,UAAU,MAAM,OAAO;KAC5C,MAAM,IAAI,MAAM,UAAU;;IAI5B,OAAO,MAAM,KAAK,SAAS,OAAO,KAAK;;GAIzC,IAAI,cAAc,WAChB,OAAO,MAAM,aAAa;GAI5B,OAAO,MAAM,mBAAmB,aAAa,aAAa,cAAc,KAAK,CAAC;;;CAIlF,OAAO;;;;;;;;;;;;;;;;;;;;;;AAuBT,eAAe,iBACb,YACA,mBACqC;CACrC,MAAM,aAAyC;EAC7C,IAAI;EACJ,MAAM,EAAE;EACR,YAAY,EAAE;EACd,SAAS;EACV;CAED,IAAI,CAAC,mBAAmB,OAAO;CAO/B,MAAM,CAAC,OAAO,QAAQ,OAAA,GAAA,0BAAA,YALV,kBAAkB,eAAe,EAC3C,YAAY,WAAW,eAAe,EACvC,CAGsC,CAAI,WAAW,WAAW,eAAe,IAAI,GAAG,CAAC;CACxF,IAAI,CAAC,MAAM,OAAO;CAGlB,MAAM,CAAC,OAAO,aAAA,GAAA,0BAAA,kBAA6B,uBAAuB,KAAK,CAAC;CACxE,IAAI,CAAC,UAAU,OAAO;CAEtB,WAAW,KAAK,SAAS,OAAO;CAChC,WAAW,OAAO,SAAS,QAAQ,EAAE;CACrC,WAAW,aAAa,SAAS,cAAc,EAAE;CACjD,WAAW,UAAU,WAAW,KAAK,SAAS,QAAQ,IAAI,WAAW,WAAW,WAAW;CAE3F,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACtNT,eAAsB,QAAW,SAAyB;CACxD,MAAM,EACJ,KACA,QAAQ,EAAE,EACV,SAAS,OACT,UAAU,EAAE,EACZ,MACA,WAAW,QACX,cAAc,QACd,UAAU,QACR;CAEJ,MAAM,UAAU,GAAG,IAAI,IAAA,GAAA,yBAAA,aAAe,MAAM;CAa5C,OAAO,MATW,SAAS,WAAW,QAAQ,SAAS;EACrD;EACA;EACA;EACA;EACA;EACA;EACD,CAAC"}
|
|
1
|
+
{"version":3,"file":"cloud.cjs","names":[],"sources":["../src/cloud/error.ts","../src/cloud/module.ts","../src/cloud/respond.ts","../src/cloud/method.ts","../src/cloud/request.ts"],"sourcesContent":["import { errorAssign } from '@cloudcome/utils-core/error';\n\nexport function createCloudObjectError(message: string, code?: number | string) {\n return errorAssign(new Error(message), {\n errCode: code,\n errMsg: message,\n });\n}\n","import { objectOmit } from '@cloudcome/utils-core/object';\nimport { createCloudObjectError } from './error';\nimport type { CloudModuleOutput } from './types';\n\n/**\n * 解析云模块输出结果\n *\n * 该函数用于处理云模块的输出,如果输出中包含错误码,则抛出相应的错误;\n * 否则返回去除错误码和错误信息后的数据部分。\n *\n * @template O - 输出数据的类型\n * @param output - 云模块的输出结果,包含errCode、errMsg和数据部分\n * @param fallbackErrorMessage - 当输出中没有错误信息时使用的默认错误消息\n * @returns 返回去除errCode和errMsg字段后的数据对象\n * @throws {CloudObjectError} 当output中存在errCode时抛出包含错误码和错误信息的异常\n *\n * @example\n * // 成功情况\n * const result = parseCloudModuleOutput({ value: 'success', errCode: 0, errMsg: '' });\n * // 返回: { value: 'success' }\n *\n * @example\n * // 错误情况\n * try {\n * parseCloudModuleOutput({ errCode: 404, errMsg: 'Not Found' });\n * } catch (error) {\n * // 抛出错误: CloudObjectError('Not Found', 404)\n * }\n */\nexport function parseCloudModuleOutput<O>(\n output: CloudModuleOutput<O>,\n fallbackErrorMessage = '',\n): Omit<O, 'errCode' | 'errMsg'> {\n if (output.errCode) {\n throw createCloudObjectError(output.errMsg || fallbackErrorMessage, output.errCode);\n }\n return objectOmit(output, ['errCode', 'errMsg']);\n}\n","import { errorNormalize } from '@cloudcome/utils-core/error';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport type { UniError } from '@/_types';\nimport type { CloudMethodOutput } from './types';\n\n/**\n * 执行云对象方法并标准化响应格式\n *\n * @template O - 函数返回值的类型\n * @param fn - 要执行的异步函数\n * @param append - 要附加到响应中的额外数据\n * @returns 标准化的云对象响应对象\n *\n * @example\n * ```typescript\n * const result = await respondCloudMethod(async () => {\n * return await getData();\n * }, { extra: 'data' });\n * ```\n */\nexport async function respondCloudMethod<O>(\n fn: () => MaybePromise<O>,\n append?: AnyObject,\n): Promise<CloudMethodOutput<O>> {\n try {\n const data = await fn();\n\n return {\n errCode: 0,\n errMsg: '',\n data,\n ...append,\n };\n } catch (err) {\n console.error('respondCloudObject error');\n console.error(err);\n\n const err2 = errorNormalize(err as UniError);\n\n return {\n errCode: err2.errCode || -1,\n errMsg: err2.errMsg || err2.message || '',\n // @ts-expect-error\n data: null,\n ...append,\n };\n }\n}\n","import { objectDefaults } from '@cloudcome/utils-core/object';\nimport { tryFlatten } from '@cloudcome/utils-core/try';\nimport { isFunction } from '@cloudcome/utils-core/type';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport { versionCompare } from '@cloudcome/utils-core/version';\nimport type z from 'zod';\nimport type { ZodObject } from 'zod';\nimport { createCloudObjectError } from './error';\nimport { parseCloudModuleOutput } from './module';\nimport { respondCloudMethod } from './respond';\nimport type { CloudMethod, CloudObjectThis } from './types';\nimport type { UniIdCommonModule } from './uni-id';\n\ntype _CloudObjectThisAppendUser = {\n id: string;\n role: string[];\n permission: string[];\n isAdmin: boolean;\n};\n\ntype _CloudObjectThisAppend = {\n options: Required<CreateCloudObjectOptions>;\n user: _CloudObjectThisAppendUser;\n};\n\nexport type CloudObjectContext = CloudObjectThis & _CloudObjectThisAppend;\n\nexport type BuildCloudMethodCreatorOptions = {\n /**\n * UniId 通用模块\n * 用于处理用户身份验证和权限管理\n * 如果提供,将在云对象执行前验证用户身份\n */\n uniIdCommonModule?: UniIdCommonModule;\n\n /**\n * 需要用户登录态的错误码\n * @default 'uni-id-check-token-failed'\n */\n requiredUserErrCode?: number | string;\n\n /**\n * 需要用户登录态的错误消息\n * @default '需要登录后才能进行此操作'\n */\n requiredUserErrMsg?: string;\n\n /**\n * 仅允许本地环境运行的错误消息\n * @default '运行环境不匹配'\n */\n onlyLocalEnvErrMsg?: string;\n\n /**\n * 版本不匹配错误消息\n * @default '应用版本过低'\n */\n appVersionTooLowErrMsg?: string;\n\n /**\n * 应用版本过高错误消息\n * @default '应用版本过高'\n */\n appVersionTooHighErrMsg?: string;\n\n /**\n * 响应附加数据函数\n * 用于在云对象响应中添加额外的上下文信息\n * @param objectThis 云对象上下文\n * @returns 返回要附加到响应中的数据对象\n */\n respondAppend?: (objectThis: CloudObjectThis) => AnyObject;\n\n /**\n * 所有云对象执行前钩子函数\n * @param context 云对象上下文,包含用户信息、选项等\n */\n onBefore?: (context: CloudObjectContext) => MaybePromise<unknown>;\n};\n\nexport type CreateCloudObjectOptions = {\n /**\n * 是否需要用户登录态\n * @default false\n */\n requiredUser?: boolean;\n\n /**\n * 是否仅在本地环境运行\n * @default false\n */\n onlyLocalEnv?: boolean;\n\n /**\n * 最小支持版本\n */\n minVersion?: string;\n\n /**\n * 最大支持版本\n */\n maxVersion?: string;\n\n /**\n * 非响应模式,常用于钩子函数中,如 _before, _after 等,\n * 文档:https://doc.dcloud.net.cn/uniCloud/cloud-obj.html#before-and-after\n */\n noRespond?: boolean;\n};\n\n/**\n * 云对象方法创建器类型定义\n *\n * 用于定义云对象方法的创建函数类型,支持两种重载形式:\n * 1. 带输入验证的版本:接收schema、处理函数和选项\n * 2. 无输入参数的版本:仅接收处理函数和选项\n */\nexport type CreateCloudMethod = {\n /**\n * 带输入验证的云对象方法创建器\n * @template S - Zod验证模式类型\n * @template O - 返回值类型\n * @param schema - Zod验证模式,用于验证输入数据\n * @param fn - 业务逻辑处理函数,接收上下文和验证后的输入数据\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <S extends ZodObject, O>(\n schema: S,\n fn: (context: CloudObjectContext, input: z.infer<S>) => MaybePromise<O>,\n options?: CreateCloudObjectOptions,\n ): CloudMethod<z.infer<S>, O>;\n\n /**\n * 无输入参数的云对象方法创建器\n * @template O - 返回值类型\n * @param fn - 业务逻辑处理函数,仅接收上下文\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <O>(fn: (context: CloudObjectContext) => MaybePromise<O>, options?: CreateCloudObjectOptions): CloudMethod<void, O>;\n};\n\n/**\n * 构建云对象方法创建器\n *\n * 该函数用于创建云对象方法的工厂函数,支持输入验证、用户身份验证、环境检查等功能。\n * 返回的创建器函数可以根据不同的配置创建云对象方法。\n *\n * @param options 构建选项,用于配置云对象方法创建器的行为\n * @returns 返回一个云对象方法创建器函数\n *\n * @example\n * // 创建一个需要用户登录的云对象方法\n * const createMethod = buildCloudMethodCreator({ uniIdCommonModule });\n * const myMethod = createMethod(async (context) => {\n * return { message: 'Hello ' + context.user.id };\n * }, { requiredUser: true });\n */\nexport function buildCloudMethodCreator(options?: BuildCloudMethodCreatorOptions) {\n const buildOptions = objectDefaults(options || {}, {\n requiredUserErrCode: 'uni-id-check-token-failed',\n requiredUserErrMsg: '需要登录后才能进行此操作',\n onlyLocalEnvErrMsg: '运行环境不匹配',\n appVersionTooLowErrMsg: '应用版本过低',\n appVersionTooHighErrMsg: '应用版本过高',\n respondAppend: () => ({}),\n onBefore: () => {},\n }) as Required<BuildCloudMethodCreatorOptions>;\n\n // @ts-expect-error\n const createCloudMethod: CreateCloudMethod = (arg0, arg1, arg2) => {\n // 确定选项来源:如果arg0是函数,则选项在arg1;否则在arg2\n const optionsSource = (isFunction(arg0) ? arg1 : arg2) as CreateCloudObjectOptions | undefined;\n\n // 设置默认选项值\n const createOptions = objectDefaults(optionsSource || {}, {\n requiredUser: false,\n onlyLocalEnv: false,\n }) as Required<CreateCloudObjectOptions>;\n\n return async function (this: CloudObjectThis, input) {\n const cloudMethod = async () => {\n const { runtimeEnv } = this.getCloudInfo();\n\n if (createOptions.onlyLocalEnv && runtimeEnv !== 'local') {\n throw createCloudObjectError(buildOptions.onlyLocalEnvErrMsg);\n }\n\n const { appVersion } = this.getClientInfo();\n\n if (createOptions.minVersion && versionCompare(appVersion, createOptions.minVersion) < 0) {\n throw createCloudObjectError(buildOptions.appVersionTooLowErrMsg);\n }\n\n if (createOptions.maxVersion && versionCompare(appVersion, createOptions.maxVersion) > 0) {\n throw createCloudObjectError(buildOptions.appVersionTooHighErrMsg);\n }\n\n // 构建附加的上下文信息,包括用户身份和权限信息\n const user = await _parseAppendUser(this, options?.uniIdCommonModule);\n const append: _CloudObjectThisAppend = {\n options: createOptions,\n user: user,\n };\n const context = Object.assign(this, append) as CloudObjectContext;\n\n // 如果需要用户登录态但用户未登录,则抛出错误\n if (createOptions.requiredUser && !user.id) {\n throw createCloudObjectError(buildOptions.requiredUserErrMsg, buildOptions.requiredUserErrCode);\n }\n\n // 执行前钩子函数\n await buildOptions.onBefore(context);\n\n // 无入参函数调用\n if (isFunction(arg0)) {\n return await arg0(context);\n }\n\n // 有入参函数调用 - 验证输入数据\n const parsed = arg0.safeParse(input);\n\n // 输入验证失败处理\n if (!parsed.success) {\n console.log(parsed.error.issues);\n\n const issue0 = parsed.error?.issues?.[0];\n\n // 处理自定义验证错误\n if (issue0?.code === 'custom') throw issue0.message;\n throw new Error('请求数据不正确');\n }\n\n // 执行业务逻辑函数,传入上下文和验证后的数据\n return await arg1(context, parsed.data);\n };\n\n // 如果设置了非响应模式,则直接执行方法,不返回响应\n if (createOptions.noRespond) {\n return await cloudMethod();\n }\n\n // 处理云对象方法响应逻辑,包括错误捕获和统一响应格式\n return await respondCloudMethod(cloudMethod, buildOptions.respondAppend(this));\n };\n };\n\n return createCloudMethod;\n}\n\n/**\n * 解析并附加用户信息到云对象上下文\n *\n * 该函数用于验证用户身份并获取用户权限信息,将结果附加到云对象上下文中的user字段\n * 如果未提供uniIdCommonModule或验证失败,则返回默认的空用户信息\n *\n * @param objectThis 云对象上下文,包含客户端信息和token等\n * @param uniIdCommonModule 可选的UniId通用模块实例,用于验证用户token\n * @returns 返回包含用户ID、角色、权限等信息的对象\n *\n * @example\n * // 成功验证用户身份\n * const user = await _parseAppendUser(this, uniIdModule);\n * // 返回: { id: 'user123', role: ['user'], permission: ['read'], isAdmin: false }\n *\n * @example\n * // 验证失败或未提供模块\n * const user = await _parseAppendUser(this);\n * // 返回: { id: '', role: [], permission: [], isAdmin: false }\n */\nasync function _parseAppendUser(\n objectThis: CloudObjectThis,\n uniIdCommonModule?: UniIdCommonModule,\n): Promise<_CloudObjectThisAppendUser> {\n const appendUser: _CloudObjectThisAppendUser = {\n id: '',\n role: [],\n permission: [],\n isAdmin: false,\n };\n\n if (!uniIdCommonModule) return appendUser;\n\n const uic = uniIdCommonModule.createInstance({\n clientInfo: objectThis.getClientInfo(),\n });\n\n // 验证用户token,忽略验证过程中的错误\n const [_err1, user] = await tryFlatten(uic.checkToken(objectThis.getUniIdToken() || ''));\n if (!user) return appendUser;\n\n // 解析验证结果,忽略解析过程中的错误\n const [_err2, userData] = tryFlatten(() => parseCloudModuleOutput(user));\n if (!userData) return appendUser;\n\n appendUser.id = userData.uid || '';\n appendUser.role = userData.role || [];\n appendUser.permission = userData.permission || [];\n appendUser.isAdmin = appendUser.role.includes('admin') && appendUser.permission.length === 0;\n\n return appendUser;\n}\n","import { qsStringify } from '@cloudcome/utils-core/qs';\nimport type { AnyObject } from '@cloudcome/utils-core/types';\n\n/**\n * HTTP 请求配置选项\n */\nexport type RequestOptions = {\n /**\n * 请求 URL 地址\n */\n url: string;\n\n /**\n * URL 查询参数,会自动拼接到 url 后面\n */\n query?: Record<string, string>;\n\n /**\n * HTTP 请求方法\n * @default 'GET'\n */\n method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS';\n\n /**\n * 请求头\n */\n headers?: Record<string, string>;\n\n /**\n * 请求体数据\n */\n data?: AnyObject;\n\n /**\n * 返回数据格式\n * @default 'json'\n */\n dataType?: string;\n\n /**\n * 请求内容类型\n * - 'json': application/json\n * - 'form': application/x-www-form-urlencoded\n * @default 'json'\n */\n contentType?: string;\n\n /**\n * 请求超时时间,单位毫秒\n * @default 10000\n */\n timeout?: number;\n};\n\n/**\n * 发起 HTTP 请求\n *\n * 基于 uniCloud.httpclient 发起 HTTP 请求,支持 GET、POST、PUT、DELETE 等方法。\n * 查询参数会自动通过 qsStringify 拼接到 URL 上。\n *\n * @template T - 响应数据的类型\n * @param options 请求配置选项\n * @returns 包含 data、status、headers 的响应对象\n *\n * @example\n * ```ts\n * // GET 请求\n * const res = await request<{ name: string }>({\n * url: 'https://api.example.com/users/1',\n * })\n * console.log(res.data) // { name: 'Alice' }\n * console.log(res.status) // 200\n *\n * // POST 请求\n * const res = await request<{ id: string }>({\n * url: 'https://api.example.com/users',\n * method: 'POST',\n * data: { name: 'Alice', age: 25 },\n * })\n *\n * // 带查询参数\n * const res = await request<{ list: any[] }>({\n * url: 'https://api.example.com/users',\n * query: { page: '1', size: '10' },\n * })\n * ```\n */\nexport async function request<T>(options: RequestOptions) {\n const {\n url,\n query = {},\n method = 'GET',\n headers = {},\n data,\n dataType = 'json',\n contentType = 'json',\n timeout = 10000,\n } = options;\n\n const fullUrl = `${url}?${qsStringify(query)}`;\n\n // 使用uniCloud.httpclient发起请求\n // @ts-expect-error: uniCloud类型定义中可能缺少httpclient属性\n const res = await uniCloud.httpclient.request(fullUrl, {\n method,\n headers,\n data,\n dataType,\n contentType,\n timeout,\n });\n\n return res as { data: T; status: number; headers: Record<string, string> };\n}\n"],"mappings":";;;;;;;;;AAEA,SAAgB,uBAAuB,SAAiB,MAAwB;CAC9E,QAAA,GAAA,4BAAA,aAAmB,IAAI,MAAM,QAAQ,EAAE;EACrC,SAAS;EACT,QAAQ;EACT,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACuBJ,SAAgB,uBACd,QACA,uBAAuB,IACQ;CAC/B,IAAI,OAAO,SACT,MAAM,uBAAuB,OAAO,UAAU,sBAAsB,OAAO,QAAQ;CAErF,QAAA,GAAA,6BAAA,YAAkB,QAAQ,CAAC,WAAW,SAAS,CAAC;;;;;;;;;;;;;;;;;;;AChBlD,eAAsB,mBACpB,IACA,QAC+B;CAC/B,IAAI;EAGF,OAAO;GACL,SAAS;GACT,QAAQ;GACR,MAAA,MALiB,IAAI;GAMrB,GAAG;GACJ;UACM,KAAK;EACZ,QAAQ,MAAM,2BAA2B;EACzC,QAAQ,MAAM,IAAI;EAElB,MAAM,QAAA,GAAA,4BAAA,gBAAsB,IAAgB;EAE5C,OAAO;GACL,SAAS,KAAK,WAAW;GACzB,QAAQ,KAAK,UAAU,KAAK,WAAW;GAEvC,MAAM;GACN,GAAG;GACJ;;;;;;;;;;;;;;;;;;;;;ACkHL,SAAgB,wBAAwB,SAA0C;CAChF,MAAM,gBAAA,GAAA,6BAAA,gBAA8B,WAAW,EAAE,EAAE;EACjD,qBAAqB;EACrB,oBAAoB;EACpB,oBAAoB;EACpB,wBAAwB;EACxB,yBAAyB;EACzB,sBAAsB,EAAE;EACxB,gBAAgB;EACjB,CAAC;CAGF,MAAM,qBAAwC,MAAM,MAAM,SAAS;EAKjE,MAAM,iBAAA,GAAA,6BAAA,kBAAA,GAAA,2BAAA,YAH4B,KAAK,GAAG,OAAO,SAGK,EAAE,EAAE;GACxD,cAAc;GACd,cAAc;GACf,CAAC;EAEF,OAAO,eAAuC,OAAO;GACnD,MAAM,cAAc,YAAY;IAC9B,MAAM,EAAE,eAAe,KAAK,cAAc;IAE1C,IAAI,cAAc,gBAAgB,eAAe,SAC/C,MAAM,uBAAuB,aAAa,mBAAmB;IAG/D,MAAM,EAAE,eAAe,KAAK,eAAe;IAE3C,IAAI,cAAc,eAAA,GAAA,8BAAA,gBAA6B,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,uBAAuB;IAGnE,IAAI,cAAc,eAAA,GAAA,8BAAA,gBAA6B,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,wBAAwB;IAIpE,MAAM,OAAO,MAAM,iBAAiB,MAAM,SAAS,kBAAkB;IACrE,MAAM,SAAiC;KACrC,SAAS;KACH;KACP;IACD,MAAM,UAAU,OAAO,OAAO,MAAM,OAAO;IAG3C,IAAI,cAAc,gBAAgB,CAAC,KAAK,IACtC,MAAM,uBAAuB,aAAa,oBAAoB,aAAa,oBAAoB;IAIjG,MAAM,aAAa,SAAS,QAAQ;IAGpC,KAAA,GAAA,2BAAA,YAAe,KAAK,EAClB,OAAO,MAAM,KAAK,QAAQ;IAI5B,MAAM,SAAS,KAAK,UAAU,MAAM;IAGpC,IAAI,CAAC,OAAO,SAAS;KACnB,QAAQ,IAAI,OAAO,MAAM,OAAO;KAEhC,MAAM,SAAS,OAAO,OAAO,SAAS;KAGtC,IAAI,QAAQ,SAAS,UAAU,MAAM,OAAO;KAC5C,MAAM,IAAI,MAAM,UAAU;;IAI5B,OAAO,MAAM,KAAK,SAAS,OAAO,KAAK;;GAIzC,IAAI,cAAc,WAChB,OAAO,MAAM,aAAa;GAI5B,OAAO,MAAM,mBAAmB,aAAa,aAAa,cAAc,KAAK,CAAC;;;CAIlF,OAAO;;;;;;;;;;;;;;;;;;;;;;AAuBT,eAAe,iBACb,YACA,mBACqC;CACrC,MAAM,aAAyC;EAC7C,IAAI;EACJ,MAAM,EAAE;EACR,YAAY,EAAE;EACd,SAAS;EACV;CAED,IAAI,CAAC,mBAAmB,OAAO;CAO/B,MAAM,CAAC,OAAO,QAAQ,OAAA,GAAA,0BAAA,YALV,kBAAkB,eAAe,EAC3C,YAAY,WAAW,eAAe,EACvC,CAGsC,CAAI,WAAW,WAAW,eAAe,IAAI,GAAG,CAAC;CACxF,IAAI,CAAC,MAAM,OAAO;CAGlB,MAAM,CAAC,OAAO,aAAA,GAAA,0BAAA,kBAA6B,uBAAuB,KAAK,CAAC;CACxE,IAAI,CAAC,UAAU,OAAO;CAEtB,WAAW,KAAK,SAAS,OAAO;CAChC,WAAW,OAAO,SAAS,QAAQ,EAAE;CACrC,WAAW,aAAa,SAAS,cAAc,EAAE;CACjD,WAAW,UAAU,WAAW,KAAK,SAAS,QAAQ,IAAI,WAAW,WAAW,WAAW;CAE3F,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACtNT,eAAsB,QAAW,SAAyB;CACxD,MAAM,EACJ,KACA,QAAQ,EAAE,EACV,SAAS,OACT,UAAU,EAAE,EACZ,MACA,WAAW,QACX,cAAc,QACd,UAAU,QACR;CAEJ,MAAM,UAAU,GAAG,IAAI,IAAA,GAAA,yBAAA,aAAe,MAAM;CAa5C,OAAO,MATW,SAAS,WAAW,QAAQ,SAAS;EACrD;EACA;EACA;EACA;EACA;EACA;EACD,CAAC"}
|
package/dist/cloud.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cloud.mjs","names":[],"sources":["../src/cloud/error.ts","../src/cloud/module.ts","../src/cloud/respond.ts","../src/cloud/method.ts","../src/cloud/request.ts"],"sourcesContent":["import { errorAssign } from '@cloudcome/utils-core/error';\n\nexport function createCloudObjectError(message: string, code?: number | string) {\n return errorAssign(new Error(message), {\n errCode: code,\n errMsg: message,\n });\n}\n","import { objectOmit } from '@cloudcome/utils-core/object';\nimport { createCloudObjectError } from './error';\nimport type { CloudModuleOutput } from './types';\n\n/**\n * 解析云模块输出结果\n *\n * 该函数用于处理云模块的输出,如果输出中包含错误码,则抛出相应的错误;\n * 否则返回去除错误码和错误信息后的数据部分。\n *\n * @template O - 输出数据的类型\n * @param output - 云模块的输出结果,包含errCode、errMsg和数据部分\n * @param fallbackErrorMessage - 当输出中没有错误信息时使用的默认错误消息\n * @returns 返回去除errCode和errMsg字段后的数据对象\n * @throws {CloudObjectError} 当output中存在errCode时抛出包含错误码和错误信息的异常\n *\n * @example\n * // 成功情况\n * const result = parseCloudModuleOutput({ value: 'success', errCode: 0, errMsg: '' });\n * // 返回: { value: 'success' }\n *\n * @example\n * // 错误情况\n * try {\n * parseCloudModuleOutput({ errCode: 404, errMsg: 'Not Found' });\n * } catch (error) {\n * // 抛出错误: CloudObjectError('Not Found', 404)\n * }\n */\nexport function parseCloudModuleOutput<O>(\n output: CloudModuleOutput<O>,\n fallbackErrorMessage = '',\n): Omit<O, 'errCode' | 'errMsg'> {\n if (output.errCode) {\n throw createCloudObjectError(output.errMsg || fallbackErrorMessage, output.errCode);\n }\n return objectOmit(output, ['errCode', 'errMsg']);\n}\n","import { errorNormalize } from '@cloudcome/utils-core/error';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport type { UniError } from '@/_types';\nimport type { CloudMethodOutput } from './types';\n\n/**\n * 执行云对象方法并标准化响应格式\n *\n * @template O - 函数返回值的类型\n * @param fn - 要执行的异步函数\n * @param append - 要附加到响应中的额外数据\n * @returns 标准化的云对象响应对象\n *\n * @example\n * ```typescript\n * const result = await respondCloudMethod(async () => {\n * return await getData();\n * }, { extra: 'data' });\n * ```\n */\nexport async function respondCloudMethod<O>(\n fn: () => MaybePromise<O>,\n append?: AnyObject,\n): Promise<CloudMethodOutput<O>> {\n try {\n const data = await fn();\n\n return {\n errCode: 0,\n errMsg: '',\n data,\n ...append,\n };\n } catch (err) {\n console.error('respondCloudObject error');\n console.error(err);\n\n const err2 = errorNormalize(err as UniError);\n\n return {\n errCode: err2.errCode || -1,\n errMsg: err2.errMsg || err2.message || '',\n // @ts-expect-error\n data: null,\n ...append,\n };\n }\n}\n","import { objectDefaults } from '@cloudcome/utils-core/object';\nimport { tryFlatten } from '@cloudcome/utils-core/try';\nimport { isFunction } from '@cloudcome/utils-core/type';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport { versionCompare } from '@cloudcome/utils-core/version';\nimport type z from 'zod';\nimport type { ZodObject } from 'zod';\nimport { createCloudObjectError } from './error';\nimport { parseCloudModuleOutput } from './module';\nimport { respondCloudMethod } from './respond';\nimport type { CloudMethod, CloudObjectThis } from './types';\nimport type { UniIdCommonModule } from './uni-id';\n\ntype _CloudObjectThisAppendUser = {\n id: string;\n role: string[];\n permission: string[];\n isAdmin: boolean;\n};\n\ntype _CloudObjectThisAppend = {\n options: Required<CreateCloudObjectOptions>;\n user: _CloudObjectThisAppendUser;\n};\n\nexport type CloudObjectContext = CloudObjectThis & _CloudObjectThisAppend;\n\nexport type BuildCloudMethodCreatorOptions = {\n /**\n * UniId 通用模块\n * 用于处理用户身份验证和权限管理\n * 如果提供,将在云对象执行前验证用户身份\n */\n uniIdCommonModule?: UniIdCommonModule;\n\n /**\n * 需要用户登录态的错误码\n * @default 'uni-id-check-token-failed'\n */\n requiredUserErrCode?: number | string;\n\n /**\n * 需要用户登录态的错误消息\n * @default '需要登录后才能进行此操作'\n */\n requiredUserErrMsg?: string;\n\n /**\n * 仅允许本地环境运行的错误消息\n * @default '运行环境不匹配'\n */\n onlyLocalEnvErrMsg?: string;\n\n /**\n * 版本不匹配错误消息\n * @default '应用版本过低'\n */\n appVersionTooLowErrMsg?: string;\n\n /**\n * 应用版本过高错误消息\n * @default '应用版本过高'\n */\n appVersionTooHighErrMsg?: string;\n\n /**\n * 响应附加数据函数\n * 用于在云对象响应中添加额外的上下文信息\n * @param objectThis 云对象上下文\n * @returns 返回要附加到响应中的数据对象\n */\n respondAppend?: (objectThis: CloudObjectThis) => AnyObject;\n\n /**\n * 所有云对象执行前钩子函数\n * @param context 云对象上下文,包含用户信息、选项等\n */\n onBefore?: (context: CloudObjectContext) => MaybePromise<unknown>;\n};\n\nexport type CreateCloudObjectOptions = {\n /**\n * 是否需要用户登录态\n * @default false\n */\n requiredUser?: boolean;\n\n /**\n * 是否仅在本地环境运行\n * @default false\n */\n onlyLocalEnv?: boolean;\n\n /**\n * 最小支持版本\n */\n minVersion?: string;\n\n /**\n * 最大支持版本\n */\n maxVersion?: string;\n\n /**\n * 非响应模式,常用于钩子函数中,如 _before, _after 等,\n * 文档:https://doc.dcloud.net.cn/uniCloud/cloud-obj.html#before-and-after\n */\n noRespond?: boolean;\n};\n\n/**\n * 云对象方法创建器类型定义\n *\n * 用于定义云对象方法的创建函数类型,支持两种重载形式:\n * 1. 带输入验证的版本:接收schema、处理函数和选项\n * 2. 无输入参数的版本:仅接收处理函数和选项\n */\nexport type CreateCloudMethod = {\n /**\n * 带输入验证的云对象方法创建器\n * @template S - Zod验证模式类型\n * @template O - 返回值类型\n * @param schema - Zod验证模式,用于验证输入数据\n * @param fn - 业务逻辑处理函数,接收上下文和验证后的输入数据\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <S extends ZodObject, O>(\n schema: S,\n fn: (context: CloudObjectContext, input: z.infer<S>) => MaybePromise<O>,\n options?: CreateCloudObjectOptions,\n ): CloudMethod<z.infer<S>, O>;\n\n /**\n * 无输入参数的云对象方法创建器\n * @template O - 返回值类型\n * @param fn - 业务逻辑处理函数,仅接收上下文\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <O>(fn: (context: CloudObjectContext) => MaybePromise<O>, options?: CreateCloudObjectOptions): CloudMethod<void, O>;\n};\n\n/**\n * 构建云对象方法创建器\n *\n * 该函数用于创建云对象方法的工厂函数,支持输入验证、用户身份验证、环境检查等功能。\n * 返回的创建器函数可以根据不同的配置创建云对象方法。\n *\n * @param options 构建选项,用于配置云对象方法创建器的行为\n * @returns 返回一个云对象方法创建器函数\n *\n * @example\n * // 创建一个需要用户登录的云对象方法\n * const createMethod = buildCloudMethodCreator({ uniIdCommonModule });\n * const myMethod = createMethod(async (context) => {\n * return { message: 'Hello ' + context.user.id };\n * }, { requiredUser: true });\n */\nexport function buildCloudMethodCreator(options?: BuildCloudMethodCreatorOptions) {\n const buildOptions = objectDefaults(options || {}, {\n requiredUserErrCode: 'uni-id-check-token-failed',\n requiredUserErrMsg: '需要登录后才能进行此操作',\n onlyLocalEnvErrMsg: '运行环境不匹配',\n appVersionTooLowErrMsg: '应用版本过低',\n appVersionTooHighErrMsg: '应用版本过高',\n respondAppend: () => ({}),\n onBefore: () => {},\n }) as Required<BuildCloudMethodCreatorOptions>;\n\n // @ts-expect-error\n const createCloudMethod: CreateCloudMethod = (arg0, arg1, arg2) => {\n // 确定选项来源:如果arg0是函数,则选项在arg1;否则在arg2\n const optionsSource = (isFunction(arg0) ? arg1 : arg2) as CreateCloudObjectOptions | undefined;\n\n // 设置默认选项值\n const createOptions = objectDefaults(optionsSource || {}, {\n requiredUser: false,\n onlyLocalEnv: false,\n }) as Required<CreateCloudObjectOptions>;\n\n return async function (input) {\n const cloudMethod = async () => {\n const { runtimeEnv } = this.getCloudInfo();\n\n if (createOptions.onlyLocalEnv && runtimeEnv !== 'local') {\n throw createCloudObjectError(buildOptions.onlyLocalEnvErrMsg);\n }\n\n const { appVersion } = this.getClientInfo();\n\n if (createOptions.minVersion && versionCompare(appVersion, createOptions.minVersion) < 0) {\n throw createCloudObjectError(buildOptions.appVersionTooLowErrMsg);\n }\n\n if (createOptions.maxVersion && versionCompare(appVersion, createOptions.maxVersion) > 0) {\n throw createCloudObjectError(buildOptions.appVersionTooHighErrMsg);\n }\n\n // 构建附加的上下文信息,包括用户身份和权限信息\n const user = await _parseAppendUser(this, options?.uniIdCommonModule);\n const append: _CloudObjectThisAppend = {\n options: createOptions,\n user: user,\n };\n const context = Object.assign(this, append) as CloudObjectContext;\n\n // 如果需要用户登录态但用户未登录,则抛出错误\n if (createOptions.requiredUser && !user.id) {\n throw createCloudObjectError(buildOptions.requiredUserErrMsg, buildOptions.requiredUserErrCode);\n }\n\n // 执行前钩子函数\n await buildOptions.onBefore(context);\n\n // 无入参函数调用\n if (isFunction(arg0)) {\n return await arg0(context);\n }\n\n // 有入参函数调用 - 验证输入数据\n const parsed = arg0.safeParse(input);\n\n // 输入验证失败处理\n if (!parsed.success) {\n console.log(parsed.error.issues);\n\n const issue0 = parsed.error?.issues?.[0];\n\n // 处理自定义验证错误\n if (issue0?.code === 'custom') throw issue0.message;\n throw new Error('请求数据不正确');\n }\n\n // 执行业务逻辑函数,传入上下文和验证后的数据\n return await arg1(context, parsed.data);\n };\n\n // 如果设置了非响应模式,则直接执行方法,不返回响应\n if (createOptions.noRespond) {\n return await cloudMethod();\n }\n\n // 处理云对象方法响应逻辑,包括错误捕获和统一响应格式\n return await respondCloudMethod(cloudMethod, buildOptions.respondAppend(this));\n };\n };\n\n return createCloudMethod;\n}\n\n/**\n * 解析并附加用户信息到云对象上下文\n *\n * 该函数用于验证用户身份并获取用户权限信息,将结果附加到云对象上下文中的user字段\n * 如果未提供uniIdCommonModule或验证失败,则返回默认的空用户信息\n *\n * @param objectThis 云对象上下文,包含客户端信息和token等\n * @param uniIdCommonModule 可选的UniId通用模块实例,用于验证用户token\n * @returns 返回包含用户ID、角色、权限等信息的对象\n *\n * @example\n * // 成功验证用户身份\n * const user = await _parseAppendUser(this, uniIdModule);\n * // 返回: { id: 'user123', role: ['user'], permission: ['read'], isAdmin: false }\n *\n * @example\n * // 验证失败或未提供模块\n * const user = await _parseAppendUser(this);\n * // 返回: { id: '', role: [], permission: [], isAdmin: false }\n */\nasync function _parseAppendUser(\n objectThis: CloudObjectThis,\n uniIdCommonModule?: UniIdCommonModule,\n): Promise<_CloudObjectThisAppendUser> {\n const appendUser: _CloudObjectThisAppendUser = {\n id: '',\n role: [],\n permission: [],\n isAdmin: false,\n };\n\n if (!uniIdCommonModule) return appendUser;\n\n const uic = uniIdCommonModule.createInstance({\n clientInfo: objectThis.getClientInfo(),\n });\n\n // 验证用户token,忽略验证过程中的错误\n const [_err1, user] = await tryFlatten(uic.checkToken(objectThis.getUniIdToken() || ''));\n if (!user) return appendUser;\n\n // 解析验证结果,忽略解析过程中的错误\n const [_err2, userData] = tryFlatten(() => parseCloudModuleOutput(user));\n if (!userData) return appendUser;\n\n appendUser.id = userData.uid || '';\n appendUser.role = userData.role || [];\n appendUser.permission = userData.permission || [];\n appendUser.isAdmin = appendUser.role.includes('admin') && appendUser.permission.length === 0;\n\n return appendUser;\n}\n","import { qsStringify } from '@cloudcome/utils-core/qs';\nimport type { AnyObject } from '@cloudcome/utils-core/types';\n\n/**\n * HTTP 请求配置选项\n */\nexport type RequestOptions = {\n /**\n * 请求 URL 地址\n */\n url: string;\n\n /**\n * URL 查询参数,会自动拼接到 url 后面\n */\n query?: Record<string, string>;\n\n /**\n * HTTP 请求方法\n * @default 'GET'\n */\n method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS';\n\n /**\n * 请求头\n */\n headers?: Record<string, string>;\n\n /**\n * 请求体数据\n */\n data?: AnyObject;\n\n /**\n * 返回数据格式\n * @default 'json'\n */\n dataType?: string;\n\n /**\n * 请求内容类型\n * - 'json': application/json\n * - 'form': application/x-www-form-urlencoded\n * @default 'json'\n */\n contentType?: string;\n\n /**\n * 请求超时时间,单位毫秒\n * @default 10000\n */\n timeout?: number;\n};\n\n/**\n * 发起 HTTP 请求\n *\n * 基于 uniCloud.httpclient 发起 HTTP 请求,支持 GET、POST、PUT、DELETE 等方法。\n * 查询参数会自动通过 qsStringify 拼接到 URL 上。\n *\n * @template T - 响应数据的类型\n * @param options 请求配置选项\n * @returns 包含 data、status、headers 的响应对象\n *\n * @example\n * ```ts\n * // GET 请求\n * const res = await request<{ name: string }>({\n * url: 'https://api.example.com/users/1',\n * })\n * console.log(res.data) // { name: 'Alice' }\n * console.log(res.status) // 200\n *\n * // POST 请求\n * const res = await request<{ id: string }>({\n * url: 'https://api.example.com/users',\n * method: 'POST',\n * data: { name: 'Alice', age: 25 },\n * })\n *\n * // 带查询参数\n * const res = await request<{ list: any[] }>({\n * url: 'https://api.example.com/users',\n * query: { page: '1', size: '10' },\n * })\n * ```\n */\nexport async function request<T>(options: RequestOptions) {\n const {\n url,\n query = {},\n method = 'GET',\n headers = {},\n data,\n dataType = 'json',\n contentType = 'json',\n timeout = 10000,\n } = options;\n\n const fullUrl = `${url}?${qsStringify(query)}`;\n\n // 使用uniCloud.httpclient发起请求\n // @ts-expect-error: uniCloud类型定义中可能缺少httpclient属性\n const res = await uniCloud.httpclient.request(fullUrl, {\n method,\n headers,\n data,\n dataType,\n contentType,\n timeout,\n });\n\n return res as { data: T; status: number; headers: Record<string, string> };\n}\n"],"mappings":";;;;;;;;AAEA,SAAgB,uBAAuB,SAAiB,MAAwB;CAC9E,OAAO,YAAY,IAAI,MAAM,QAAQ,EAAE;EACrC,SAAS;EACT,QAAQ;EACT,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACuBJ,SAAgB,uBACd,QACA,uBAAuB,IACQ;CAC/B,IAAI,OAAO,SACT,MAAM,uBAAuB,OAAO,UAAU,sBAAsB,OAAO,QAAQ;CAErF,OAAO,WAAW,QAAQ,CAAC,WAAW,SAAS,CAAC;;;;;;;;;;;;;;;;;;;AChBlD,eAAsB,mBACpB,IACA,QAC+B;CAC/B,IAAI;EAGF,OAAO;GACL,SAAS;GACT,QAAQ;GACR,MAAA,MALiB,IAAI;GAMrB,GAAG;GACJ;UACM,KAAK;EACZ,QAAQ,MAAM,2BAA2B;EACzC,QAAQ,MAAM,IAAI;EAElB,MAAM,OAAO,eAAe,IAAgB;EAE5C,OAAO;GACL,SAAS,KAAK,WAAW;GACzB,QAAQ,KAAK,UAAU,KAAK,WAAW;GAEvC,MAAM;GACN,GAAG;GACJ;;;;;;;;;;;;;;;;;;;;;ACkHL,SAAgB,wBAAwB,SAA0C;CAChF,MAAM,eAAe,eAAe,WAAW,EAAE,EAAE;EACjD,qBAAqB;EACrB,oBAAoB;EACpB,oBAAoB;EACpB,wBAAwB;EACxB,yBAAyB;EACzB,sBAAsB,EAAE;EACxB,gBAAgB;EACjB,CAAC;CAGF,MAAM,qBAAwC,MAAM,MAAM,SAAS;EAKjE,MAAM,gBAAgB,gBAHC,WAAW,KAAK,GAAG,OAAO,SAGK,EAAE,EAAE;GACxD,cAAc;GACd,cAAc;GACf,CAAC;EAEF,OAAO,eAAgB,OAAO;GAC5B,MAAM,cAAc,YAAY;IAC9B,MAAM,EAAE,eAAe,KAAK,cAAc;IAE1C,IAAI,cAAc,gBAAgB,eAAe,SAC/C,MAAM,uBAAuB,aAAa,mBAAmB;IAG/D,MAAM,EAAE,eAAe,KAAK,eAAe;IAE3C,IAAI,cAAc,cAAc,eAAe,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,uBAAuB;IAGnE,IAAI,cAAc,cAAc,eAAe,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,wBAAwB;IAIpE,MAAM,OAAO,MAAM,iBAAiB,MAAM,SAAS,kBAAkB;IACrE,MAAM,SAAiC;KACrC,SAAS;KACH;KACP;IACD,MAAM,UAAU,OAAO,OAAO,MAAM,OAAO;IAG3C,IAAI,cAAc,gBAAgB,CAAC,KAAK,IACtC,MAAM,uBAAuB,aAAa,oBAAoB,aAAa,oBAAoB;IAIjG,MAAM,aAAa,SAAS,QAAQ;IAGpC,IAAI,WAAW,KAAK,EAClB,OAAO,MAAM,KAAK,QAAQ;IAI5B,MAAM,SAAS,KAAK,UAAU,MAAM;IAGpC,IAAI,CAAC,OAAO,SAAS;KACnB,QAAQ,IAAI,OAAO,MAAM,OAAO;KAEhC,MAAM,SAAS,OAAO,OAAO,SAAS;KAGtC,IAAI,QAAQ,SAAS,UAAU,MAAM,OAAO;KAC5C,MAAM,IAAI,MAAM,UAAU;;IAI5B,OAAO,MAAM,KAAK,SAAS,OAAO,KAAK;;GAIzC,IAAI,cAAc,WAChB,OAAO,MAAM,aAAa;GAI5B,OAAO,MAAM,mBAAmB,aAAa,aAAa,cAAc,KAAK,CAAC;;;CAIlF,OAAO;;;;;;;;;;;;;;;;;;;;;;AAuBT,eAAe,iBACb,YACA,mBACqC;CACrC,MAAM,aAAyC;EAC7C,IAAI;EACJ,MAAM,EAAE;EACR,YAAY,EAAE;EACd,SAAS;EACV;CAED,IAAI,CAAC,mBAAmB,OAAO;CAO/B,MAAM,CAAC,OAAO,QAAQ,MAAM,WALhB,kBAAkB,eAAe,EAC3C,YAAY,WAAW,eAAe,EACvC,CAGsC,CAAI,WAAW,WAAW,eAAe,IAAI,GAAG,CAAC;CACxF,IAAI,CAAC,MAAM,OAAO;CAGlB,MAAM,CAAC,OAAO,YAAY,iBAAiB,uBAAuB,KAAK,CAAC;CACxE,IAAI,CAAC,UAAU,OAAO;CAEtB,WAAW,KAAK,SAAS,OAAO;CAChC,WAAW,OAAO,SAAS,QAAQ,EAAE;CACrC,WAAW,aAAa,SAAS,cAAc,EAAE;CACjD,WAAW,UAAU,WAAW,KAAK,SAAS,QAAQ,IAAI,WAAW,WAAW,WAAW;CAE3F,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACtNT,eAAsB,QAAW,SAAyB;CACxD,MAAM,EACJ,KACA,QAAQ,EAAE,EACV,SAAS,OACT,UAAU,EAAE,EACZ,MACA,WAAW,QACX,cAAc,QACd,UAAU,QACR;CAEJ,MAAM,UAAU,GAAG,IAAI,GAAG,YAAY,MAAM;CAa5C,OAAO,MATW,SAAS,WAAW,QAAQ,SAAS;EACrD;EACA;EACA;EACA;EACA;EACA;EACD,CAAC"}
|
|
1
|
+
{"version":3,"file":"cloud.mjs","names":[],"sources":["../src/cloud/error.ts","../src/cloud/module.ts","../src/cloud/respond.ts","../src/cloud/method.ts","../src/cloud/request.ts"],"sourcesContent":["import { errorAssign } from '@cloudcome/utils-core/error';\n\nexport function createCloudObjectError(message: string, code?: number | string) {\n return errorAssign(new Error(message), {\n errCode: code,\n errMsg: message,\n });\n}\n","import { objectOmit } from '@cloudcome/utils-core/object';\nimport { createCloudObjectError } from './error';\nimport type { CloudModuleOutput } from './types';\n\n/**\n * 解析云模块输出结果\n *\n * 该函数用于处理云模块的输出,如果输出中包含错误码,则抛出相应的错误;\n * 否则返回去除错误码和错误信息后的数据部分。\n *\n * @template O - 输出数据的类型\n * @param output - 云模块的输出结果,包含errCode、errMsg和数据部分\n * @param fallbackErrorMessage - 当输出中没有错误信息时使用的默认错误消息\n * @returns 返回去除errCode和errMsg字段后的数据对象\n * @throws {CloudObjectError} 当output中存在errCode时抛出包含错误码和错误信息的异常\n *\n * @example\n * // 成功情况\n * const result = parseCloudModuleOutput({ value: 'success', errCode: 0, errMsg: '' });\n * // 返回: { value: 'success' }\n *\n * @example\n * // 错误情况\n * try {\n * parseCloudModuleOutput({ errCode: 404, errMsg: 'Not Found' });\n * } catch (error) {\n * // 抛出错误: CloudObjectError('Not Found', 404)\n * }\n */\nexport function parseCloudModuleOutput<O>(\n output: CloudModuleOutput<O>,\n fallbackErrorMessage = '',\n): Omit<O, 'errCode' | 'errMsg'> {\n if (output.errCode) {\n throw createCloudObjectError(output.errMsg || fallbackErrorMessage, output.errCode);\n }\n return objectOmit(output, ['errCode', 'errMsg']);\n}\n","import { errorNormalize } from '@cloudcome/utils-core/error';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport type { UniError } from '@/_types';\nimport type { CloudMethodOutput } from './types';\n\n/**\n * 执行云对象方法并标准化响应格式\n *\n * @template O - 函数返回值的类型\n * @param fn - 要执行的异步函数\n * @param append - 要附加到响应中的额外数据\n * @returns 标准化的云对象响应对象\n *\n * @example\n * ```typescript\n * const result = await respondCloudMethod(async () => {\n * return await getData();\n * }, { extra: 'data' });\n * ```\n */\nexport async function respondCloudMethod<O>(\n fn: () => MaybePromise<O>,\n append?: AnyObject,\n): Promise<CloudMethodOutput<O>> {\n try {\n const data = await fn();\n\n return {\n errCode: 0,\n errMsg: '',\n data,\n ...append,\n };\n } catch (err) {\n console.error('respondCloudObject error');\n console.error(err);\n\n const err2 = errorNormalize(err as UniError);\n\n return {\n errCode: err2.errCode || -1,\n errMsg: err2.errMsg || err2.message || '',\n // @ts-expect-error\n data: null,\n ...append,\n };\n }\n}\n","import { objectDefaults } from '@cloudcome/utils-core/object';\nimport { tryFlatten } from '@cloudcome/utils-core/try';\nimport { isFunction } from '@cloudcome/utils-core/type';\nimport type { MaybePromise } from '@cloudcome/utils-core/types';\nimport { versionCompare } from '@cloudcome/utils-core/version';\nimport type z from 'zod';\nimport type { ZodObject } from 'zod';\nimport { createCloudObjectError } from './error';\nimport { parseCloudModuleOutput } from './module';\nimport { respondCloudMethod } from './respond';\nimport type { CloudMethod, CloudObjectThis } from './types';\nimport type { UniIdCommonModule } from './uni-id';\n\ntype _CloudObjectThisAppendUser = {\n id: string;\n role: string[];\n permission: string[];\n isAdmin: boolean;\n};\n\ntype _CloudObjectThisAppend = {\n options: Required<CreateCloudObjectOptions>;\n user: _CloudObjectThisAppendUser;\n};\n\nexport type CloudObjectContext = CloudObjectThis & _CloudObjectThisAppend;\n\nexport type BuildCloudMethodCreatorOptions = {\n /**\n * UniId 通用模块\n * 用于处理用户身份验证和权限管理\n * 如果提供,将在云对象执行前验证用户身份\n */\n uniIdCommonModule?: UniIdCommonModule;\n\n /**\n * 需要用户登录态的错误码\n * @default 'uni-id-check-token-failed'\n */\n requiredUserErrCode?: number | string;\n\n /**\n * 需要用户登录态的错误消息\n * @default '需要登录后才能进行此操作'\n */\n requiredUserErrMsg?: string;\n\n /**\n * 仅允许本地环境运行的错误消息\n * @default '运行环境不匹配'\n */\n onlyLocalEnvErrMsg?: string;\n\n /**\n * 版本不匹配错误消息\n * @default '应用版本过低'\n */\n appVersionTooLowErrMsg?: string;\n\n /**\n * 应用版本过高错误消息\n * @default '应用版本过高'\n */\n appVersionTooHighErrMsg?: string;\n\n /**\n * 响应附加数据函数\n * 用于在云对象响应中添加额外的上下文信息\n * @param objectThis 云对象上下文\n * @returns 返回要附加到响应中的数据对象\n */\n respondAppend?: (objectThis: CloudObjectThis) => AnyObject;\n\n /**\n * 所有云对象执行前钩子函数\n * @param context 云对象上下文,包含用户信息、选项等\n */\n onBefore?: (context: CloudObjectContext) => MaybePromise<unknown>;\n};\n\nexport type CreateCloudObjectOptions = {\n /**\n * 是否需要用户登录态\n * @default false\n */\n requiredUser?: boolean;\n\n /**\n * 是否仅在本地环境运行\n * @default false\n */\n onlyLocalEnv?: boolean;\n\n /**\n * 最小支持版本\n */\n minVersion?: string;\n\n /**\n * 最大支持版本\n */\n maxVersion?: string;\n\n /**\n * 非响应模式,常用于钩子函数中,如 _before, _after 等,\n * 文档:https://doc.dcloud.net.cn/uniCloud/cloud-obj.html#before-and-after\n */\n noRespond?: boolean;\n};\n\n/**\n * 云对象方法创建器类型定义\n *\n * 用于定义云对象方法的创建函数类型,支持两种重载形式:\n * 1. 带输入验证的版本:接收schema、处理函数和选项\n * 2. 无输入参数的版本:仅接收处理函数和选项\n */\nexport type CreateCloudMethod = {\n /**\n * 带输入验证的云对象方法创建器\n * @template S - Zod验证模式类型\n * @template O - 返回值类型\n * @param schema - Zod验证模式,用于验证输入数据\n * @param fn - 业务逻辑处理函数,接收上下文和验证后的输入数据\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <S extends ZodObject, O>(\n schema: S,\n fn: (context: CloudObjectContext, input: z.infer<S>) => MaybePromise<O>,\n options?: CreateCloudObjectOptions,\n ): CloudMethod<z.infer<S>, O>;\n\n /**\n * 无输入参数的云对象方法创建器\n * @template O - 返回值类型\n * @param fn - 业务逻辑处理函数,仅接收上下文\n * @param options - 云对象创建选项\n * @returns 云对象方法函数\n */\n <O>(fn: (context: CloudObjectContext) => MaybePromise<O>, options?: CreateCloudObjectOptions): CloudMethod<void, O>;\n};\n\n/**\n * 构建云对象方法创建器\n *\n * 该函数用于创建云对象方法的工厂函数,支持输入验证、用户身份验证、环境检查等功能。\n * 返回的创建器函数可以根据不同的配置创建云对象方法。\n *\n * @param options 构建选项,用于配置云对象方法创建器的行为\n * @returns 返回一个云对象方法创建器函数\n *\n * @example\n * // 创建一个需要用户登录的云对象方法\n * const createMethod = buildCloudMethodCreator({ uniIdCommonModule });\n * const myMethod = createMethod(async (context) => {\n * return { message: 'Hello ' + context.user.id };\n * }, { requiredUser: true });\n */\nexport function buildCloudMethodCreator(options?: BuildCloudMethodCreatorOptions) {\n const buildOptions = objectDefaults(options || {}, {\n requiredUserErrCode: 'uni-id-check-token-failed',\n requiredUserErrMsg: '需要登录后才能进行此操作',\n onlyLocalEnvErrMsg: '运行环境不匹配',\n appVersionTooLowErrMsg: '应用版本过低',\n appVersionTooHighErrMsg: '应用版本过高',\n respondAppend: () => ({}),\n onBefore: () => {},\n }) as Required<BuildCloudMethodCreatorOptions>;\n\n // @ts-expect-error\n const createCloudMethod: CreateCloudMethod = (arg0, arg1, arg2) => {\n // 确定选项来源:如果arg0是函数,则选项在arg1;否则在arg2\n const optionsSource = (isFunction(arg0) ? arg1 : arg2) as CreateCloudObjectOptions | undefined;\n\n // 设置默认选项值\n const createOptions = objectDefaults(optionsSource || {}, {\n requiredUser: false,\n onlyLocalEnv: false,\n }) as Required<CreateCloudObjectOptions>;\n\n return async function (this: CloudObjectThis, input) {\n const cloudMethod = async () => {\n const { runtimeEnv } = this.getCloudInfo();\n\n if (createOptions.onlyLocalEnv && runtimeEnv !== 'local') {\n throw createCloudObjectError(buildOptions.onlyLocalEnvErrMsg);\n }\n\n const { appVersion } = this.getClientInfo();\n\n if (createOptions.minVersion && versionCompare(appVersion, createOptions.minVersion) < 0) {\n throw createCloudObjectError(buildOptions.appVersionTooLowErrMsg);\n }\n\n if (createOptions.maxVersion && versionCompare(appVersion, createOptions.maxVersion) > 0) {\n throw createCloudObjectError(buildOptions.appVersionTooHighErrMsg);\n }\n\n // 构建附加的上下文信息,包括用户身份和权限信息\n const user = await _parseAppendUser(this, options?.uniIdCommonModule);\n const append: _CloudObjectThisAppend = {\n options: createOptions,\n user: user,\n };\n const context = Object.assign(this, append) as CloudObjectContext;\n\n // 如果需要用户登录态但用户未登录,则抛出错误\n if (createOptions.requiredUser && !user.id) {\n throw createCloudObjectError(buildOptions.requiredUserErrMsg, buildOptions.requiredUserErrCode);\n }\n\n // 执行前钩子函数\n await buildOptions.onBefore(context);\n\n // 无入参函数调用\n if (isFunction(arg0)) {\n return await arg0(context);\n }\n\n // 有入参函数调用 - 验证输入数据\n const parsed = arg0.safeParse(input);\n\n // 输入验证失败处理\n if (!parsed.success) {\n console.log(parsed.error.issues);\n\n const issue0 = parsed.error?.issues?.[0];\n\n // 处理自定义验证错误\n if (issue0?.code === 'custom') throw issue0.message;\n throw new Error('请求数据不正确');\n }\n\n // 执行业务逻辑函数,传入上下文和验证后的数据\n return await arg1(context, parsed.data);\n };\n\n // 如果设置了非响应模式,则直接执行方法,不返回响应\n if (createOptions.noRespond) {\n return await cloudMethod();\n }\n\n // 处理云对象方法响应逻辑,包括错误捕获和统一响应格式\n return await respondCloudMethod(cloudMethod, buildOptions.respondAppend(this));\n };\n };\n\n return createCloudMethod;\n}\n\n/**\n * 解析并附加用户信息到云对象上下文\n *\n * 该函数用于验证用户身份并获取用户权限信息,将结果附加到云对象上下文中的user字段\n * 如果未提供uniIdCommonModule或验证失败,则返回默认的空用户信息\n *\n * @param objectThis 云对象上下文,包含客户端信息和token等\n * @param uniIdCommonModule 可选的UniId通用模块实例,用于验证用户token\n * @returns 返回包含用户ID、角色、权限等信息的对象\n *\n * @example\n * // 成功验证用户身份\n * const user = await _parseAppendUser(this, uniIdModule);\n * // 返回: { id: 'user123', role: ['user'], permission: ['read'], isAdmin: false }\n *\n * @example\n * // 验证失败或未提供模块\n * const user = await _parseAppendUser(this);\n * // 返回: { id: '', role: [], permission: [], isAdmin: false }\n */\nasync function _parseAppendUser(\n objectThis: CloudObjectThis,\n uniIdCommonModule?: UniIdCommonModule,\n): Promise<_CloudObjectThisAppendUser> {\n const appendUser: _CloudObjectThisAppendUser = {\n id: '',\n role: [],\n permission: [],\n isAdmin: false,\n };\n\n if (!uniIdCommonModule) return appendUser;\n\n const uic = uniIdCommonModule.createInstance({\n clientInfo: objectThis.getClientInfo(),\n });\n\n // 验证用户token,忽略验证过程中的错误\n const [_err1, user] = await tryFlatten(uic.checkToken(objectThis.getUniIdToken() || ''));\n if (!user) return appendUser;\n\n // 解析验证结果,忽略解析过程中的错误\n const [_err2, userData] = tryFlatten(() => parseCloudModuleOutput(user));\n if (!userData) return appendUser;\n\n appendUser.id = userData.uid || '';\n appendUser.role = userData.role || [];\n appendUser.permission = userData.permission || [];\n appendUser.isAdmin = appendUser.role.includes('admin') && appendUser.permission.length === 0;\n\n return appendUser;\n}\n","import { qsStringify } from '@cloudcome/utils-core/qs';\nimport type { AnyObject } from '@cloudcome/utils-core/types';\n\n/**\n * HTTP 请求配置选项\n */\nexport type RequestOptions = {\n /**\n * 请求 URL 地址\n */\n url: string;\n\n /**\n * URL 查询参数,会自动拼接到 url 后面\n */\n query?: Record<string, string>;\n\n /**\n * HTTP 请求方法\n * @default 'GET'\n */\n method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS';\n\n /**\n * 请求头\n */\n headers?: Record<string, string>;\n\n /**\n * 请求体数据\n */\n data?: AnyObject;\n\n /**\n * 返回数据格式\n * @default 'json'\n */\n dataType?: string;\n\n /**\n * 请求内容类型\n * - 'json': application/json\n * - 'form': application/x-www-form-urlencoded\n * @default 'json'\n */\n contentType?: string;\n\n /**\n * 请求超时时间,单位毫秒\n * @default 10000\n */\n timeout?: number;\n};\n\n/**\n * 发起 HTTP 请求\n *\n * 基于 uniCloud.httpclient 发起 HTTP 请求,支持 GET、POST、PUT、DELETE 等方法。\n * 查询参数会自动通过 qsStringify 拼接到 URL 上。\n *\n * @template T - 响应数据的类型\n * @param options 请求配置选项\n * @returns 包含 data、status、headers 的响应对象\n *\n * @example\n * ```ts\n * // GET 请求\n * const res = await request<{ name: string }>({\n * url: 'https://api.example.com/users/1',\n * })\n * console.log(res.data) // { name: 'Alice' }\n * console.log(res.status) // 200\n *\n * // POST 请求\n * const res = await request<{ id: string }>({\n * url: 'https://api.example.com/users',\n * method: 'POST',\n * data: { name: 'Alice', age: 25 },\n * })\n *\n * // 带查询参数\n * const res = await request<{ list: any[] }>({\n * url: 'https://api.example.com/users',\n * query: { page: '1', size: '10' },\n * })\n * ```\n */\nexport async function request<T>(options: RequestOptions) {\n const {\n url,\n query = {},\n method = 'GET',\n headers = {},\n data,\n dataType = 'json',\n contentType = 'json',\n timeout = 10000,\n } = options;\n\n const fullUrl = `${url}?${qsStringify(query)}`;\n\n // 使用uniCloud.httpclient发起请求\n // @ts-expect-error: uniCloud类型定义中可能缺少httpclient属性\n const res = await uniCloud.httpclient.request(fullUrl, {\n method,\n headers,\n data,\n dataType,\n contentType,\n timeout,\n });\n\n return res as { data: T; status: number; headers: Record<string, string> };\n}\n"],"mappings":";;;;;;;;AAEA,SAAgB,uBAAuB,SAAiB,MAAwB;CAC9E,OAAO,YAAY,IAAI,MAAM,QAAQ,EAAE;EACrC,SAAS;EACT,QAAQ;EACT,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACuBJ,SAAgB,uBACd,QACA,uBAAuB,IACQ;CAC/B,IAAI,OAAO,SACT,MAAM,uBAAuB,OAAO,UAAU,sBAAsB,OAAO,QAAQ;CAErF,OAAO,WAAW,QAAQ,CAAC,WAAW,SAAS,CAAC;;;;;;;;;;;;;;;;;;;AChBlD,eAAsB,mBACpB,IACA,QAC+B;CAC/B,IAAI;EAGF,OAAO;GACL,SAAS;GACT,QAAQ;GACR,MAAA,MALiB,IAAI;GAMrB,GAAG;GACJ;UACM,KAAK;EACZ,QAAQ,MAAM,2BAA2B;EACzC,QAAQ,MAAM,IAAI;EAElB,MAAM,OAAO,eAAe,IAAgB;EAE5C,OAAO;GACL,SAAS,KAAK,WAAW;GACzB,QAAQ,KAAK,UAAU,KAAK,WAAW;GAEvC,MAAM;GACN,GAAG;GACJ;;;;;;;;;;;;;;;;;;;;;ACkHL,SAAgB,wBAAwB,SAA0C;CAChF,MAAM,eAAe,eAAe,WAAW,EAAE,EAAE;EACjD,qBAAqB;EACrB,oBAAoB;EACpB,oBAAoB;EACpB,wBAAwB;EACxB,yBAAyB;EACzB,sBAAsB,EAAE;EACxB,gBAAgB;EACjB,CAAC;CAGF,MAAM,qBAAwC,MAAM,MAAM,SAAS;EAKjE,MAAM,gBAAgB,gBAHC,WAAW,KAAK,GAAG,OAAO,SAGK,EAAE,EAAE;GACxD,cAAc;GACd,cAAc;GACf,CAAC;EAEF,OAAO,eAAuC,OAAO;GACnD,MAAM,cAAc,YAAY;IAC9B,MAAM,EAAE,eAAe,KAAK,cAAc;IAE1C,IAAI,cAAc,gBAAgB,eAAe,SAC/C,MAAM,uBAAuB,aAAa,mBAAmB;IAG/D,MAAM,EAAE,eAAe,KAAK,eAAe;IAE3C,IAAI,cAAc,cAAc,eAAe,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,uBAAuB;IAGnE,IAAI,cAAc,cAAc,eAAe,YAAY,cAAc,WAAW,GAAG,GACrF,MAAM,uBAAuB,aAAa,wBAAwB;IAIpE,MAAM,OAAO,MAAM,iBAAiB,MAAM,SAAS,kBAAkB;IACrE,MAAM,SAAiC;KACrC,SAAS;KACH;KACP;IACD,MAAM,UAAU,OAAO,OAAO,MAAM,OAAO;IAG3C,IAAI,cAAc,gBAAgB,CAAC,KAAK,IACtC,MAAM,uBAAuB,aAAa,oBAAoB,aAAa,oBAAoB;IAIjG,MAAM,aAAa,SAAS,QAAQ;IAGpC,IAAI,WAAW,KAAK,EAClB,OAAO,MAAM,KAAK,QAAQ;IAI5B,MAAM,SAAS,KAAK,UAAU,MAAM;IAGpC,IAAI,CAAC,OAAO,SAAS;KACnB,QAAQ,IAAI,OAAO,MAAM,OAAO;KAEhC,MAAM,SAAS,OAAO,OAAO,SAAS;KAGtC,IAAI,QAAQ,SAAS,UAAU,MAAM,OAAO;KAC5C,MAAM,IAAI,MAAM,UAAU;;IAI5B,OAAO,MAAM,KAAK,SAAS,OAAO,KAAK;;GAIzC,IAAI,cAAc,WAChB,OAAO,MAAM,aAAa;GAI5B,OAAO,MAAM,mBAAmB,aAAa,aAAa,cAAc,KAAK,CAAC;;;CAIlF,OAAO;;;;;;;;;;;;;;;;;;;;;;AAuBT,eAAe,iBACb,YACA,mBACqC;CACrC,MAAM,aAAyC;EAC7C,IAAI;EACJ,MAAM,EAAE;EACR,YAAY,EAAE;EACd,SAAS;EACV;CAED,IAAI,CAAC,mBAAmB,OAAO;CAO/B,MAAM,CAAC,OAAO,QAAQ,MAAM,WALhB,kBAAkB,eAAe,EAC3C,YAAY,WAAW,eAAe,EACvC,CAGsC,CAAI,WAAW,WAAW,eAAe,IAAI,GAAG,CAAC;CACxF,IAAI,CAAC,MAAM,OAAO;CAGlB,MAAM,CAAC,OAAO,YAAY,iBAAiB,uBAAuB,KAAK,CAAC;CACxE,IAAI,CAAC,UAAU,OAAO;CAEtB,WAAW,KAAK,SAAS,OAAO;CAChC,WAAW,OAAO,SAAS,QAAQ,EAAE;CACrC,WAAW,aAAa,SAAS,cAAc,EAAE;CACjD,WAAW,UAAU,WAAW,KAAK,SAAS,QAAQ,IAAI,WAAW,WAAW,WAAW;CAE3F,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACtNT,eAAsB,QAAW,SAAyB;CACxD,MAAM,EACJ,KACA,QAAQ,EAAE,EACV,SAAS,OACT,UAAU,EAAE,EACZ,MACA,WAAW,QACX,cAAc,QACd,UAAU,QACR;CAEJ,MAAM,UAAU,GAAG,IAAI,GAAG,YAAY,MAAM;CAa5C,OAAO,MATW,SAAS,WAAW,QAAQ,SAAS;EACrD;EACA;EACA;EACA;EACA;EACA;EACD,CAAC"}
|
package/dist/index.cjs
CHANGED
package/dist/index.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudcome/utils-uni",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.38.0",
|
|
4
4
|
"description": "cloudcome utils for uni-app",
|
|
5
5
|
"main": "./dist/index.cjs",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
},
|
|
59
59
|
"dependencies": {
|
|
60
60
|
"@cloudcome/utils-core": "~1.22.0",
|
|
61
|
-
"@cloudcome/utils-vue": "~1.
|
|
61
|
+
"@cloudcome/utils-vue": "~1.15.0",
|
|
62
62
|
"@dcloudio/types": "^3.4.31",
|
|
63
63
|
"@dcloudio/uni-app": "3.0.0-alpha-5000820260430001",
|
|
64
64
|
"vue": "^3.5.34",
|