@cloudcome/utils-uni 1.33.0 → 1.34.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/README.md +3 -4
- package/dist/{app.d.ts → client/app.d.ts} +13 -0
- package/dist/client/async.d.ts +25 -0
- package/dist/client/message.d.ts +35 -0
- package/dist/client/request.d.ts +128 -0
- package/dist/client/ui.d.ts +26 -0
- package/dist/client.cjs +376 -1
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.ts +6 -127
- package/dist/client.mjs +363 -2
- package/dist/client.mjs.map +1 -1
- package/dist/cloud.cjs +1 -1
- package/dist/cloud.mjs +1 -1
- package/dist/database.cjs +1 -1
- package/dist/database.mjs +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +2 -18
- package/dist/app.cjs +0 -44
- package/dist/app.cjs.map +0 -1
- package/dist/app.mjs +0 -43
- package/dist/app.mjs.map +0 -1
- package/dist/page.cjs +0 -108
- package/dist/page.cjs.map +0 -1
- package/dist/page.mjs +0 -105
- package/dist/page.mjs.map +0 -1
- /package/dist/{page.d.ts → client/page.d.ts} +0 -0
package/dist/client.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.cjs","names":[],"sources":["../src/client.ts"],"sourcesContent":["import type { AnyArray, AnyFunction } from '@cloudcome/utils-core/types';\nimport {\n type UseRequestOptions,\n type UseRequestOutput,\n type UseRequestOutputFilled,\n useRequest,\n} from '@cloudcome/utils-vue/request';\nimport type { CloudMethodOutput, UniError } from '@/cloud';\nimport type { ClientDatabaseOutput } from '@/database';\nimport { parseCloudMethodOutput } from './_helpers';\n\ntype _ImportObject = UniCloudNamespace.UniCloud['importObject'];\ntype _ImportObjectArgs = Parameters<_ImportObject>;\ntype _ImportObjectOptions = _ImportObjectArgs[1];\n\nexport type CreateUseCloudObjectOptions = _ImportObjectOptions & {\n /**\n * 模拟云对象,用于单元测试\n * @private\n */\n // biome-ignore lint/suspicious/noExplicitAny: 单测使用 any\n _mockServer?: any;\n\n /**\n * 回退错误信息\n * @default '请求失败'\n */\n fallbackErrorMessage?: string;\n\n /**\n * 请求开始前的回调函数\n */\n onBefore?: () => unknown;\n\n /**\n * 请求成功后的回调函数\n */\n onSuccess?: () => unknown;\n\n /**\n * 请求失败时的回调函数\n * @param err 错误信息\n */\n onError?: (err: UniError) => unknown;\n\n /**\n * 请求完成后的回调函数(无论成功或失败都会执行)\n */\n onAfter?: () => unknown;\n\n /**\n * 显示加载状态的回调函数,当配置了 showLoading 为 true 时会调用\n */\n onShowLoading?: () => unknown;\n\n /**\n * 隐藏加载状态的回调函数,当配置了 showLoading 为 true 时会调用\n */\n onHideLoading?: () => unknown;\n\n /**\n * 显示错误信息的回调函数,当配置了 showError 为 true 时会调用\n * @param err 错误信息\n */\n onShowError?: (err: UniError) => unknown;\n};\n\n/**\n * 云对象请求函数类型定义\n * @template F 云对象方法函数类型\n * @param input 云对象方法的参数数组\n * @returns 返回云对象方法执行结果的Promise\n */\nexport type CloudObjectRequest = <F extends AnyFunction>(\n ...input: Parameters<F>\n) => Promise<CloudMethodOutput<ReturnType<F>>>;\n\n/**\n * 用于调用云对象方法的配置选项类型定义\n * @template I 输入参数类型数组\n * @template O 输出结果类型\n */\nexport type UseCloudMethodOptions<I extends AnyArray, O> = Omit<\n UseRequestOptions<I, O>,\n 'onError'\n> & {\n /**\n * 请求发生错误时的回调函数\n * @param err 错误信息\n * @param inputs 请求输入参数\n */\n onError?: (err: UniError, ...inputs: I) => unknown;\n\n /**\n * 是否显示加载状态\n * @default false\n */\n showLoading?: boolean;\n\n /**\n * 是否显示错误信息\n * @default false\n */\n showError?: boolean;\n};\n\n/**\n * 用于调用云对象方法的hook函数类型定义\n * @template I 输入参数类型数组\n * @template O 输出结果类型\n */\nexport type UseCloudMethod<Api extends Record<string, AnyFunction>> = {\n /**\n * 重载签名:当提供 placeholder 选项时,返回包含初始值的输出类型\n * @param method 云对象方法名\n * @param caller 调用云对象方法的函数\n * @param options 包含 placeholder 的请求配置选项\n * @returns 返回包含初始值的请求输出\n */\n <K extends keyof Api, I extends AnyArray, O>(\n method: K,\n caller: (request: Api[K], ...inputs: I) => Promise<CloudMethodOutput<O>>,\n options: Omit<UseCloudMethodOptions<I, O>, 'placeholder'> & {\n placeholder: () => O;\n },\n ): UseRequestOutputFilled<I, O>;\n\n /**\n * 重载签名:当不提供 placeholder 选项时,返回普通输出类型\n * @param method 云对象方法名\n * @param caller 调用云对象方法的函数\n * @param options 可选的请求配置选项\n * @returns 返回普通的请求输出\n */\n <K extends keyof Api, I extends AnyArray, O>(\n method: K,\n caller: (request: Api[K], ...inputs: I) => Promise<CloudMethodOutput<O>>,\n options?: UseCloudMethodOptions<I, O>,\n ): UseRequestOutput<I, O>;\n};\n\n/**\n * 导入云对象并创建一个用于调用云对象的hook\n * @param objectName 云对象名称\n * @param importOptions 配置选项,包含模拟服务器、回退错误信息等\n * @returns 返回一个可用于调用云对象方法的hook函数\n */\nexport function importCloudObject<Api extends Record<string, AnyFunction>>(\n objectName: _ImportObjectArgs[0],\n importOptions?: CreateUseCloudObjectOptions,\n) {\n const fallbackErrorMessage =\n importOptions?.fallbackErrorMessage || '请求失败';\n const server =\n importOptions?._mockServer ||\n uniCloud.importObject(objectName, importOptions);\n const onShowLoading =\n importOptions?.onShowLoading ||\n (() => uni.showLoading({ title: '', mask: true }));\n const onHideLoading =\n importOptions?.onHideLoading || (() => uni.hideLoading());\n const onShowError =\n importOptions?.onShowError ||\n ((err) =>\n uni.showToast({\n title: err.message,\n icon: 'none',\n duration: 3000,\n mask: false,\n }));\n\n /**\n * 用于调用云对象方法的hook函数\n * @template I 输入参数类型\n * @template O 输出结果类型\n * @param method 云对象方法名\n * @param caller 调用云对象的函数\n * @param options 配置选项,包含请求相关的配置\n * @returns 返回一个请求hook,用于处理云对象调用\n */\n const useCloudMethod: UseCloudMethod<Api> = (method, caller, options) => {\n // 使用请求hook处理云对象调用\n return useRequest(\n async (...inputs) => {\n const request = server[method];\n const output = await caller(request, ...inputs);\n return parseCloudMethodOutput(output, fallbackErrorMessage);\n },\n {\n ...options,\n async onBefore(...inputs) {\n if (options?.showLoading) onShowLoading();\n\n await importOptions?.onBefore?.();\n await options?.onBefore?.(...inputs);\n },\n async onSuccess(data, ...inputs) {\n await importOptions?.onSuccess?.();\n await options?.onSuccess?.(data, ...inputs);\n },\n async onError(err, ...inputs) {\n await importOptions?.onError?.(err as UniError);\n await options?.onError?.(err as UniError, ...inputs);\n\n if (options?.showError) {\n // 加延迟是尽量保证在 loading 隐藏后再显示错误信息\n setTimeout(() => {\n onShowError(err as UniError);\n });\n }\n },\n async onAfter(...inputs) {\n if (options?.showLoading) onHideLoading();\n\n await importOptions?.onAfter?.();\n await options?.onAfter?.(...inputs);\n },\n },\n );\n };\n\n return useCloudMethod;\n}\n\nexport type UseDatabaseOptions<I extends AnyArray, O> = UseRequestOptions<\n I,\n O\n> & {\n /**\n * 模拟数据库,用于单元测试\n */\n // biome-ignore lint/suspicious/noExplicitAny: 单测使用 any\n _mockDatabase?: any;\n};\n\n/**\n * 创建一个用于调用云数据库的hook\n * @param caller 调用云数据库的函数,接收数据库实例和输入参数,返回Promise\n * @param options 配置选项\n * @returns 返回一个请求hook,用于处理云数据库调用\n */\nexport function useDatabase<I extends AnyArray, O>(\n caller: (\n db: UniCloud.Database,\n ...inputs: I\n ) => Promise<ClientDatabaseOutput<O>>,\n options: Omit<UseDatabaseOptions<I, O>, 'placeholder'> & {\n placeholder: () => O;\n },\n): UseRequestOutputFilled<I, O>;\nexport function useDatabase<I extends AnyArray, O>(\n caller: (\n db: UniCloud.Database,\n ...inputs: I\n ) => Promise<ClientDatabaseOutput<O>>,\n options?: UseDatabaseOptions<I, O>,\n): UseRequestOutput<I, O>;\nexport function useDatabase<I extends AnyArray, O>(\n caller: (\n db: UniCloud.Database,\n ...inputs: I\n ) => Promise<ClientDatabaseOutput<O>>,\n options?: UseDatabaseOptions<I, O>,\n): UseRequestOutput<I, O> {\n // 获取数据库实例,优先使用模拟数据库(用于测试),否则使用uniCloud数据库\n const db = options?._mockDatabase || uniCloud.database();\n return useRequest(async (...inputs: I) => {\n const { result } = await caller(db, ...inputs);\n if (!result.errCode) return result;\n throw new Error(result.errMsg || '请求失败');\n }, options);\n}\n\nexport { parseCloudMethodOutput } from './_helpers';\nexport type { UniError } from './_types';\n"],"mappings":";;;;;;;;;;AAmJA,SAAgB,kBACd,YACA,eACA;CACA,MAAM,uBACJ,eAAe,wBAAwB;CACzC,MAAM,SACJ,eAAe,eACf,SAAS,aAAa,YAAY,cAAc;CAClD,MAAM,gBACJ,eAAe,wBACR,IAAI,YAAY;EAAE,OAAO;EAAI,MAAM;EAAM,CAAC;CACnD,MAAM,gBACJ,eAAe,wBAAwB,IAAI,aAAa;CAC1D,MAAM,cACJ,eAAe,iBACb,QACA,IAAI,UAAU;EACZ,OAAO,IAAI;EACX,MAAM;EACN,UAAU;EACV,MAAM;EACP,CAAC;;;;;;;;;;CAWN,MAAM,kBAAuC,QAAQ,QAAQ,YAAY;EAEvE,QAAA,GAAA,6BAAA,YACE,OAAO,GAAG,WAAW;GACnB,MAAM,UAAU,OAAO;GAEvB,OAAO,iBAAA,uBAAuB,MADT,OAAO,SAAS,GAAG,OAAO,EACT,qBAAqB;KAE7D;GACE,GAAG;GACH,MAAM,SAAS,GAAG,QAAQ;IACxB,IAAI,SAAS,aAAa,eAAe;IAEzC,MAAM,eAAe,YAAY;IACjC,MAAM,SAAS,WAAW,GAAG,OAAO;;GAEtC,MAAM,UAAU,MAAM,GAAG,QAAQ;IAC/B,MAAM,eAAe,aAAa;IAClC,MAAM,SAAS,YAAY,MAAM,GAAG,OAAO;;GAE7C,MAAM,QAAQ,KAAK,GAAG,QAAQ;IAC5B,MAAM,eAAe,UAAU,IAAgB;IAC/C,MAAM,SAAS,UAAU,KAAiB,GAAG,OAAO;IAEpD,IAAI,SAAS,WAEX,iBAAiB;KACf,YAAY,IAAgB;MAC5B;;GAGN,MAAM,QAAQ,GAAG,QAAQ;IACvB,IAAI,SAAS,aAAa,eAAe;IAEzC,MAAM,eAAe,WAAW;IAChC,MAAM,SAAS,UAAU,GAAG,OAAO;;GAEtC,CACF;;CAGH,OAAO;;AAoCT,SAAgB,YACd,QAIA,SACwB;CAExB,MAAM,KAAK,SAAS,iBAAiB,SAAS,UAAU;CACxD,QAAA,GAAA,6BAAA,YAAkB,OAAO,GAAG,WAAc;EACxC,MAAM,EAAE,WAAW,MAAM,OAAO,IAAI,GAAG,OAAO;EAC9C,IAAI,CAAC,OAAO,SAAS,OAAO;EAC5B,MAAM,IAAI,MAAM,OAAO,UAAU,OAAO;IACvC,QAAQ"}
|
|
1
|
+
{"version":3,"file":"client.cjs","names":[],"sources":["../src/client/message.ts","../src/client/app.ts","../src/client/async.ts","../src/client/page.ts","../src/client/request.ts","../src/client/ui.ts"],"sourcesContent":["import { promiseDelay } from '@cloudcome/utils-core/promise';\nimport { isString } from '@cloudcome/utils-core/type';\n\n/**\n * 显示 confirm 提示\n * @param text 提示文本\n * @param options 其他选项\n * @returns 提示完成后的 Promise\n */\nexport function uniConfirm(\n text: string,\n options?: Omit<\n UniNamespace.ShowModalOptions,\n 'showCancel' | 'success' | 'content' | 'editable'\n >,\n) {\n const cancelText = options?.cancelText || '取消';\n const confirmText = options?.confirmText || '确认';\n\n if (cancelText.length > 4)\n console.warn('微信小程序内不支持 cancelText 长度超过 4 个字符');\n if (confirmText.length > 4)\n console.warn('微信小程序内不支持 confirmText 长度超过 4 个字符');\n\n return new Promise<boolean>((resolve) => {\n // 避免和 hideLoading 同时出现影响弹窗\n setTimeout(() => {\n uni.showModal({\n title: '请确认',\n content: text,\n showCancel: true,\n confirmText,\n cancelText,\n ...options,\n success(result) {\n resolve(result.confirm);\n },\n });\n });\n });\n}\n\n/**\n * 显示 prompt 提示\n * @param text 提示文本\n * @param options 其他选项\n * @returns 提示完成后的 Promise\n */\nexport function uniPrompt(\n text: string,\n options?: Omit<\n UniNamespace.ShowModalOptions,\n 'showCancel' | 'success' | 'content' | 'editable'\n >,\n) {\n const cancelText = options?.cancelText || '取消';\n const confirmText = options?.confirmText || '确认';\n\n if (cancelText.length > 4)\n console.warn('微信小程序内不支持 cancelText 长度超过 4 个字符');\n if (confirmText.length > 4)\n console.warn('微信小程序内不支持 confirmText 长度超过 4 个字符');\n\n return new Promise<string>((resolve) => {\n // 避免和 hideLoading 同时出现影响弹窗\n setTimeout(() => {\n uni.showModal({\n title: '请输入',\n content: '',\n placeholderText: text,\n showCancel: true,\n confirmText,\n cancelText,\n editable: true,\n ...options,\n success(result) {\n resolve(result.content || '');\n },\n });\n });\n });\n}\n\n/**\n * 显示 alert 提示\n * @param text 提示文本\n * @param options 其他选项\n * @returns 提示完成后的 Promise\n */\nexport function uniAlert(\n text: string,\n options?: Omit<\n UniNamespace.ShowModalOptions,\n 'cancelText' | 'showCancel' | 'success' | 'content'\n >,\n) {\n const confirmText = options?.confirmText || '好';\n\n if (confirmText.length > 4)\n console.warn('微信小程序内不支持 confirmText 长度超过 4 个字符');\n\n return new Promise<void>((resolve) => {\n // 避免和 hideLoading 同时出现影响弹窗\n setTimeout(() => {\n uni.showModal({\n title: '提示',\n confirmText,\n cancelText: '',\n ...options,\n content: text,\n showCancel: false,\n success() {\n resolve();\n },\n });\n });\n });\n}\n\n/**\n * 显示 toast 提示\n * @param text 提示文本\n * @param icon 图标\n * @param options 其他选项\n * @returns 提示完成后的 Promise\n */\nexport function uniToast(\n text: string,\n icon?: UniNamespace.ShowToastOptions['icon'],\n): Promise<void>;\nexport function uniToast(\n text: string,\n options?: UniNamespace.ShowToastOptions,\n): Promise<void>;\nexport function uniToast(\n text: string,\n iconOrOptions?:\n | UniNamespace.ShowToastOptions['icon']\n | UniNamespace.ShowToastOptions,\n): Promise<void> {\n const options = {} as UniNamespace.ShowToastOptions;\n\n if (isString(iconOrOptions)) {\n options.icon = iconOrOptions;\n } else {\n Object.assign(options, iconOrOptions);\n }\n\n return new Promise<void>((resolve) => {\n // 避免和 hideLoading 同时出现影响弹窗\n setTimeout(async () => {\n uni.showToast({\n title: text,\n duration: 2900,\n icon: options.icon || 'none',\n });\n promiseDelay(3000).then(resolve);\n });\n });\n}\n\n/**\n * 显示 loading 提示\n * @param title 提示文本\n */\nexport function uniLoading(title?: string) {\n uni.showLoading({\n title,\n mask: true,\n });\n}\n","import type { HookListenerWithDispose } from '@cloudcome/utils-vue/component';\nimport { _runLifeHook } from '@cloudcome/utils-vue/shared';\nimport { onHide, onShow } from '@dcloudio/uni-app';\nimport { ref } from 'vue';\nimport { uniConfirm } from './message';\n\n/**\n * 应用显示状态生命周期钩子函数\n *\n * 该函数用于监听应用从后台进入前台的生命周期事件。\n * 当应用从后台切换到前台时触发 onShow 回调,\n * 当应用从前台切换到后台时触发 onHide 回调。\n *\n * @param appShow - 应用显示状态变化时的回调函数,可以返回一个清理函数\n *\n * @example\n * // 基本用法\n * useAppShow(() => {\n * console.log('应用进入前台');\n *\n * // 可选:返回一个清理函数,在应用进入后台时执行\n * return () => {\n * console.log('应用进入后台');\n * };\n * });\n *\n * @example\n * // 带有异步操作的用法\n * useAppShow(async () => {\n * // 应用进入前台时刷新数据\n * await refreshUserData();\n *\n * // 返回清理函数\n * return () => {\n * // 应用进入后台时保存数据\n * saveUserData();\n * };\n * });\n */\nexport function useAppShow(appShow: HookListenerWithDispose) {\n _runLifeHook(onShow, onHide, appShow);\n}\n\n/**\n * 订阅模板消息\n * @param templateId 模板消息 ID 或 ID 列表\n * @returns Promise<boolean>\n */\nexport async function uniSubscribeNotice(templateId: string | string[]) {\n if (!uni.requestSubscribeMessage) return false;\n\n return new Promise<boolean>((resolve) => {\n const tmplIds = Array.isArray(templateId) ? templateId : [templateId];\n uni.requestSubscribeMessage({\n tmplIds,\n success(_res) {\n // 'accept'表示用户同意订阅该条id对应的模板消息,\n // 'reject'表示用户拒绝订阅该条id对应的模板消息,\n // 'ban'表示已被后台封禁,\n // 'filter'表示该模板因为模板标题同名被后台过滤\n const res = _res as unknown as Record<\n string,\n 'accept' | 'reject' | 'ban' | 'filter'\n >;\n let subscribed = false;\n\n for (const templateId of tmplIds) {\n if (res[templateId] === 'accept') {\n subscribed = true;\n break;\n }\n }\n\n resolve(subscribed);\n },\n fail() {\n resolve(false);\n },\n });\n });\n}\n\n/**\n * 监听应用更新状态\n */\nexport function useAppUpdate() {\n const hasUpdate = ref(false);\n const updateReady = ref(false);\n const updateManager = uni.getUpdateManager?.();\n\n updateManager?.onCheckForUpdate((res) => {\n // 请求完新版本信息的回调\n hasUpdate.value = Boolean(res.hasUpdate);\n });\n\n updateManager?.onUpdateReady(async () => {\n updateReady.value = true;\n\n const confirm = await uniConfirm('新版本已经准备好,是否重启应用?', {\n title: '更新提示',\n confirmText: '重启',\n });\n if (!confirm) return;\n\n updateManager.applyUpdate();\n });\n\n updateManager?.onUpdateFailed(() => {\n // 新的版本下载失败\n });\n\n return { hasUpdate, updateReady };\n}\n","import { errorAssign } from '@cloudcome/utils-core/error';\n\nexport type UniFailErr = UniNamespace.GeneralCallbackResult & {\n errCode?: number;\n errno?: number;\n};\n\nexport type UniPromiseError = Error & {\n errCode: number;\n errNo: number;\n};\n\n/**\n * 包装 uni 异步函数,返回 Promise 并处理错误\n * @param promise uni 异步函数的 Promise\n * @returns Promise<T>\n * @throws UniPromiseError\n */\nexport async function uniPromise<T>(promise: Promise<T>): Promise<T> {\n try {\n const result = await promise;\n return result;\n } catch (err) {\n const res = err as unknown as UniFailErr;\n throw errorAssign(new Error(res.errMsg || '未知错误'), {\n errCode: res.errCode || -1,\n errNo: res.errno || -1,\n });\n }\n}\n\n/**\n * 包装 uni 异步函数,返回 Promise 并处理错误\n * @param runner uni 异步函数的回调\n * @returns Promise<T>\n * @throws UniPromiseError\n */\nexport async function uniCallback<T>(\n runner: (options: {\n success: (res: T) => void;\n fail: (err: UniFailErr) => void;\n }) => unknown,\n) {\n return new Promise<T>((resolve, reject) => {\n runner({\n success(res) {\n resolve(res);\n },\n fail(err) {\n reject(\n errorAssign(new Error(err.errMsg || '未知错误'), {\n errCode: err.errCode || -1,\n errNo: err.errno || -1,\n }),\n );\n },\n });\n });\n}\n","import type { AnyObject } from '@cloudcome/utils-core/types';\nimport type { HookListenerWithDispose } from '@cloudcome/utils-vue/component';\nimport { _runLifeHook } from '@cloudcome/utils-vue/shared';\nimport { onLoad, onPageHide, onPageShow, onUnload } from '@dcloudio/uni-app';\nimport { type Reactive, reactive } from 'vue';\n\n/**\n * 用于获取页面参数的 hook 函数\n * @template T - 页面参数对象的类型,继承自 AnyObject\n * @param {function} [onPageLoad] - 页面加载时的回调函数\n * @param {T} onLoad.query - 页面参数对象\n * @returns {T} 响应式的页面参数对象\n * @example\n * // 基本用法\n * const query = usePageQuery();\n *\n * // 带回调的用法\n * const query = usePageQuery((query) => {\n * console.log('页面参数:', query);\n * });\n *\n * // 指定参数类型\n * interface PageParams {\n * id: string;\n * name?: string;\n * }\n * const query = usePageQuery<PageParams>();\n */\nexport function usePageQuery<T extends AnyObject>(\n onPageLoad?: (query: Reactive<T>) => void,\n) {\n const query = reactive<T>({} as T);\n\n onLoad((_query) => {\n Object.assign(query, _query);\n onPageLoad?.(query);\n });\n\n return query;\n}\n\n/**\n * 用于处理页面加载生命周期的 hook 函数\n *\n * 该函数会在页面加载时执行传入的回调函数,并在页面卸载时执行清理操作(如果提供了清理函数)。\n * 它是 uni-app 中 onLoad 和 onUnload 生命周期的封装。\n *\n * @param {HookListenerWithDispose} load - 页面加载时的回调函数,可以返回一个清理函数\n *\n * @example\n * // 基本用法\n * usePageLoad(() => {\n * console.log('页面已加载');\n * });\n *\n * @example\n * // 带清理函数的用法\n * usePageLoad(() => {\n * console.log('页面已加载');\n *\n * // 返回一个清理函数,在页面卸载时执行\n * return () => {\n * console.log('页面将要卸载');\n * };\n * });\n *\n * @example\n * // 异步用法\n * usePageLoad(async () => {\n * const data = await fetchData();\n * console.log('获取到数据:', data);\n *\n * return () => {\n * console.log('清理资源');\n * };\n * });\n */\nexport function usePageLoad(load: HookListenerWithDispose) {\n _runLifeHook(onLoad, onUnload, load);\n}\n\n/**\n * 用于处理页面显示生命周期的 hook 函数\n *\n * 该函数会在页面显示时执行传入的回调函数,并在页面隐藏时执行清理操作(如果提供了清理函数)。\n * 它是 uni-app 中 onPageShow 和 onPageHide 生命周期的封装。\n *\n * @param {HookListenerWithDispose} pageShow - 页面显示时的回调函数,可以返回一个清理函数\n *\n * @example\n * // 基本用法\n * usePageShow(() => {\n * console.log('页面已显示');\n * });\n *\n * @example\n * // 带清理函数的用法\n * usePageShow(() => {\n * console.log('页面已显示');\n *\n * // 返回一个清理函数,在页面隐藏时执行\n * return () => {\n * console.log('页面将要隐藏');\n * };\n * });\n */\nexport function usePageShow(pageShow: HookListenerWithDispose) {\n _runLifeHook(onPageShow, onPageHide, pageShow);\n}\n","import type { AnyArray, AnyFunction } from '@cloudcome/utils-core/types';\nimport {\n type UseRequestOptions,\n type UseRequestOutput,\n type UseRequestOutputFilled,\n useRequest,\n} from '@cloudcome/utils-vue/request';\nimport type { CloudMethodOutput, UniError } from '@/cloud';\nimport type { ClientDatabaseOutput } from '@/database';\nimport { parseCloudMethodOutput } from '../_helpers';\n\ntype _ImportObject = UniCloudNamespace.UniCloud['importObject'];\ntype _ImportObjectArgs = Parameters<_ImportObject>;\ntype _ImportObjectOptions = _ImportObjectArgs[1];\n\nexport type CreateUseCloudObjectOptions = _ImportObjectOptions & {\n /**\n * 模拟云对象,用于单元测试\n * @private\n */\n // biome-ignore lint/suspicious/noExplicitAny: 单测使用 any\n _mockServer?: any;\n\n /**\n * 回退错误信息\n * @default '请求失败'\n */\n fallbackErrorMessage?: string;\n\n /**\n * 请求开始前的回调函数\n */\n onBefore?: () => unknown;\n\n /**\n * 请求成功后的回调函数\n */\n onSuccess?: () => unknown;\n\n /**\n * 请求失败时的回调函数\n * @param err 错误信息\n */\n onError?: (err: UniError) => unknown;\n\n /**\n * 请求完成后的回调函数(无论成功或失败都会执行)\n */\n onAfter?: () => unknown;\n\n /**\n * 显示加载状态的回调函数,当配置了 showLoading 为 true 时会调用\n */\n onShowLoading?: () => unknown;\n\n /**\n * 隐藏加载状态的回调函数,当配置了 showLoading 为 true 时会调用\n */\n onHideLoading?: () => unknown;\n\n /**\n * 显示错误信息的回调函数,当配置了 showError 为 true 时会调用\n * @param err 错误信息\n */\n onShowError?: (err: UniError) => unknown;\n};\n\n/**\n * 云对象请求函数类型定义\n * @template F 云对象方法函数类型\n * @param input 云对象方法的参数数组\n * @returns 返回云对象方法执行结果的Promise\n */\nexport type CloudObjectRequest = <F extends AnyFunction>(\n ...input: Parameters<F>\n) => Promise<CloudMethodOutput<ReturnType<F>>>;\n\n/**\n * 用于调用云对象方法的配置选项类型定义\n * @template I 输入参数类型数组\n * @template O 输出结果类型\n */\nexport type UseCloudMethodOptions<I extends AnyArray, O> = Omit<\n UseRequestOptions<I, O>,\n 'onError'\n> & {\n /**\n * 请求发生错误时的回调函数\n * @param err 错误信息\n * @param inputs 请求输入参数\n */\n onError?: (err: UniError, ...inputs: I) => unknown;\n\n /**\n * 是否显示加载状态\n * @default false\n */\n showLoading?: boolean;\n\n /**\n * 是否显示错误信息\n * @default false\n */\n showError?: boolean;\n};\n\n/**\n * 用于调用云对象方法的hook函数类型定义\n * @template I 输入参数类型数组\n * @template O 输出结果类型\n */\nexport type UseCloudMethod<Api extends Record<string, AnyFunction>> = {\n /**\n * 重载签名:当提供 placeholder 选项时,返回包含初始值的输出类型\n * @param method 云对象方法名\n * @param caller 调用云对象方法的函数\n * @param options 包含 placeholder 的请求配置选项\n * @returns 返回包含初始值的请求输出\n */\n <K extends keyof Api, I extends AnyArray, O>(\n method: K,\n caller: (request: Api[K], ...inputs: I) => Promise<CloudMethodOutput<O>>,\n options: Omit<UseCloudMethodOptions<I, O>, 'placeholder'> & {\n placeholder: () => O;\n },\n ): UseRequestOutputFilled<I, O>;\n\n /**\n * 重载签名:当不提供 placeholder 选项时,返回普通输出类型\n * @param method 云对象方法名\n * @param caller 调用云对象方法的函数\n * @param options 可选的请求配置选项\n * @returns 返回普通的请求输出\n */\n <K extends keyof Api, I extends AnyArray, O>(\n method: K,\n caller: (request: Api[K], ...inputs: I) => Promise<CloudMethodOutput<O>>,\n options?: UseCloudMethodOptions<I, O>,\n ): UseRequestOutput<I, O>;\n};\n\n/**\n * 导入云对象并创建一个用于调用云对象的hook\n * @param objectName 云对象名称\n * @param importOptions 配置选项,包含模拟服务器、回退错误信息等\n * @returns 返回一个可用于调用云对象方法的hook函数\n */\nexport function importCloudObject<Api extends Record<string, AnyFunction>>(\n objectName: _ImportObjectArgs[0],\n importOptions?: CreateUseCloudObjectOptions,\n) {\n const fallbackErrorMessage =\n importOptions?.fallbackErrorMessage || '请求失败';\n const server =\n importOptions?._mockServer ||\n uniCloud.importObject(objectName, importOptions);\n const onShowLoading =\n importOptions?.onShowLoading ||\n (() => uni.showLoading({ title: '', mask: true }));\n const onHideLoading =\n importOptions?.onHideLoading || (() => uni.hideLoading());\n const onShowError =\n importOptions?.onShowError ||\n ((err) =>\n uni.showToast({\n title: err.message,\n icon: 'none',\n duration: 3000,\n mask: false,\n }));\n\n /**\n * 用于调用云对象方法的hook函数\n * @template I 输入参数类型\n * @template O 输出结果类型\n * @param method 云对象方法名\n * @param caller 调用云对象的函数\n * @param options 配置选项,包含请求相关的配置\n * @returns 返回一个请求hook,用于处理云对象调用\n */\n const useCloudMethod: UseCloudMethod<Api> = (method, caller, options) => {\n // 使用请求hook处理云对象调用\n return useRequest(\n async (...inputs) => {\n const request = server[method];\n const output = await caller(request, ...inputs);\n return parseCloudMethodOutput(output, fallbackErrorMessage);\n },\n {\n ...options,\n async onBefore(...inputs) {\n if (options?.showLoading) onShowLoading();\n\n await importOptions?.onBefore?.();\n await options?.onBefore?.(...inputs);\n },\n async onSuccess(data, ...inputs) {\n await importOptions?.onSuccess?.();\n await options?.onSuccess?.(data, ...inputs);\n },\n async onError(err, ...inputs) {\n await importOptions?.onError?.(err as UniError);\n await options?.onError?.(err as UniError, ...inputs);\n\n if (options?.showError) {\n // 加延迟是尽量保证在 loading 隐藏后再显示错误信息\n setTimeout(() => {\n onShowError(err as UniError);\n });\n }\n },\n async onAfter(...inputs) {\n if (options?.showLoading) onHideLoading();\n\n await importOptions?.onAfter?.();\n await options?.onAfter?.(...inputs);\n },\n },\n );\n };\n\n return useCloudMethod;\n}\n\nexport type UseDatabaseOptions<I extends AnyArray, O> = UseRequestOptions<\n I,\n O\n> & {\n /**\n * 模拟数据库,用于单元测试\n */\n // biome-ignore lint/suspicious/noExplicitAny: 单测使用 any\n _mockDatabase?: any;\n};\n\n/**\n * 创建一个用于调用云数据库的hook\n * @param caller 调用云数据库的函数,接收数据库实例和输入参数,返回Promise\n * @param options 配置选项\n * @returns 返回一个请求hook,用于处理云数据库调用\n */\nexport function useDatabase<I extends AnyArray, O>(\n caller: (\n db: UniCloud.Database,\n ...inputs: I\n ) => Promise<ClientDatabaseOutput<O>>,\n options: Omit<UseDatabaseOptions<I, O>, 'placeholder'> & {\n placeholder: () => O;\n },\n): UseRequestOutputFilled<I, O>;\nexport function useDatabase<I extends AnyArray, O>(\n caller: (\n db: UniCloud.Database,\n ...inputs: I\n ) => Promise<ClientDatabaseOutput<O>>,\n options?: UseDatabaseOptions<I, O>,\n): UseRequestOutput<I, O>;\nexport function useDatabase<I extends AnyArray, O>(\n caller: (\n db: UniCloud.Database,\n ...inputs: I\n ) => Promise<ClientDatabaseOutput<O>>,\n options?: UseDatabaseOptions<I, O>,\n): UseRequestOutput<I, O> {\n // 获取数据库实例,优先使用模拟数据库(用于测试),否则使用uniCloud数据库\n const db = options?._mockDatabase || uniCloud.database();\n return useRequest(async (...inputs: I) => {\n const { result } = await caller(db, ...inputs);\n if (!result.errCode) return result;\n throw new Error(result.errMsg || '请求失败');\n }, options);\n}\n","import type { ComponentInternalInstance } from 'vue';\n\nexport type Rect = {\n /**\n * 元素距离屏幕的左坐标,单位:px\n */\n left: number;\n /**\n * 元素距离屏幕的上坐标,单位:px\n */\n top: number;\n /**\n * 元素距离屏幕的宽度,单位:px\n */\n width: number;\n /**\n * 元素距离屏幕的高度,单位:px\n */\n height: number;\n};\n\n/**\n * 查询元素距离屏幕的矩形信息\n * @param instance 组件实例\n * @param selector 选择器\n * @returns 元素距离屏幕的矩形信息\n */\nexport async function querySelectorRects(\n instance: ComponentInternalInstance,\n selector: string,\n) {\n return new Promise<Rect[]>((resolve) => {\n uni\n .createSelectorQuery()\n .in(instance.proxy)\n .selectAll(selector)\n .boundingClientRect((_rects) => {\n const rects = _rects as UniApp.NodeInfo[];\n resolve(\n rects.map((rect) => ({\n left: rect.left || 0,\n top: rect.top || 0,\n width: rect.width || 0,\n height: rect.height || 0,\n })),\n );\n })\n .exec();\n });\n}\n"],"mappings":";;;;;;;;;;;;;;;;AASA,SAAgB,WACd,MACA,SAIA;CACA,MAAM,aAAa,SAAS,cAAc;CAC1C,MAAM,cAAc,SAAS,eAAe;CAE5C,IAAI,WAAW,SAAS,GACtB,QAAQ,KAAK,kCAAkC;CACjD,IAAI,YAAY,SAAS,GACvB,QAAQ,KAAK,mCAAmC;CAElD,OAAO,IAAI,SAAkB,YAAY;EAEvC,iBAAiB;GACf,IAAI,UAAU;IACZ,OAAO;IACP,SAAS;IACT,YAAY;IACZ;IACA;IACA,GAAG;IACH,QAAQ,QAAQ;KACd,QAAQ,OAAO,QAAQ;;IAE1B,CAAC;IACF;GACF;;;;;;;;AASJ,SAAgB,UACd,MACA,SAIA;CACA,MAAM,aAAa,SAAS,cAAc;CAC1C,MAAM,cAAc,SAAS,eAAe;CAE5C,IAAI,WAAW,SAAS,GACtB,QAAQ,KAAK,kCAAkC;CACjD,IAAI,YAAY,SAAS,GACvB,QAAQ,KAAK,mCAAmC;CAElD,OAAO,IAAI,SAAiB,YAAY;EAEtC,iBAAiB;GACf,IAAI,UAAU;IACZ,OAAO;IACP,SAAS;IACT,iBAAiB;IACjB,YAAY;IACZ;IACA;IACA,UAAU;IACV,GAAG;IACH,QAAQ,QAAQ;KACd,QAAQ,OAAO,WAAW,GAAG;;IAEhC,CAAC;IACF;GACF;;;;;;;;AASJ,SAAgB,SACd,MACA,SAIA;CACA,MAAM,cAAc,SAAS,eAAe;CAE5C,IAAI,YAAY,SAAS,GACvB,QAAQ,KAAK,mCAAmC;CAElD,OAAO,IAAI,SAAe,YAAY;EAEpC,iBAAiB;GACf,IAAI,UAAU;IACZ,OAAO;IACP;IACA,YAAY;IACZ,GAAG;IACH,SAAS;IACT,YAAY;IACZ,UAAU;KACR,SAAS;;IAEZ,CAAC;IACF;GACF;;AAkBJ,SAAgB,SACd,MACA,eAGe;CACf,MAAM,UAAU,EAAE;CAElB,KAAA,GAAA,2BAAA,UAAa,cAAc,EACzB,QAAQ,OAAO;MAEf,OAAO,OAAO,SAAS,cAAc;CAGvC,OAAO,IAAI,SAAe,YAAY;EAEpC,WAAW,YAAY;GACrB,IAAI,UAAU;IACZ,OAAO;IACP,UAAU;IACV,MAAM,QAAQ,QAAQ;IACvB,CAAC;GACF,CAAA,GAAA,8BAAA,cAAa,IAAK,CAAC,KAAK,QAAQ;IAChC;GACF;;;;;;AAOJ,SAAgB,WAAW,OAAgB;CACzC,IAAI,YAAY;EACd;EACA,MAAM;EACP,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AClIJ,SAAgB,WAAW,SAAkC;CAC3D,CAAA,GAAA,4BAAA,cAAa,kBAAA,QAAQ,kBAAA,QAAQ,QAAQ;;;;;;;AAQvC,eAAsB,mBAAmB,YAA+B;CACtE,IAAI,CAAC,IAAI,yBAAyB,OAAO;CAEzC,OAAO,IAAI,SAAkB,YAAY;EACvC,MAAM,UAAU,MAAM,QAAQ,WAAW,GAAG,aAAa,CAAC,WAAW;EACrE,IAAI,wBAAwB;GAC1B;GACA,QAAQ,MAAM;IAKZ,MAAM,MAAM;IAIZ,IAAI,aAAa;IAEjB,KAAK,MAAM,cAAc,SACvB,IAAI,IAAI,gBAAgB,UAAU;KAChC,aAAa;KACb;;IAIJ,QAAQ,WAAW;;GAErB,OAAO;IACL,QAAQ,MAAM;;GAEjB,CAAC;GACF;;;;;AAMJ,SAAgB,eAAe;CAC7B,MAAM,aAAA,GAAA,IAAA,KAAgB,MAAM;CAC5B,MAAM,eAAA,GAAA,IAAA,KAAkB,MAAM;CAC9B,MAAM,gBAAgB,IAAI,oBAAoB;CAE9C,eAAe,kBAAkB,QAAQ;EAEvC,UAAU,QAAQ,QAAQ,IAAI,UAAU;GACxC;CAEF,eAAe,cAAc,YAAY;EACvC,YAAY,QAAQ;EAMpB,IAAI,CAAC,MAJiB,WAAW,oBAAoB;GACnD,OAAO;GACP,aAAa;GACd,CAAC,EACY;EAEd,cAAc,aAAa;GAC3B;CAEF,eAAe,qBAAqB,GAElC;CAEF,OAAO;EAAE;EAAW;EAAa;;;;;;;;;;AC7FnC,eAAsB,WAAc,SAAiC;CACnE,IAAI;EAEF,OAAO,MADc;UAEd,KAAK;EACZ,MAAM,MAAM;EACZ,OAAA,GAAA,4BAAA,aAAkB,IAAI,MAAM,IAAI,UAAU,OAAO,EAAE;GACjD,SAAS,IAAI,WAAW;GACxB,OAAO,IAAI,SAAS;GACrB,CAAC;;;;;;;;;AAUN,eAAsB,YACpB,QAIA;CACA,OAAO,IAAI,SAAY,SAAS,WAAW;EACzC,OAAO;GACL,QAAQ,KAAK;IACX,QAAQ,IAAI;;GAEd,KAAK,KAAK;IACR,QAAA,GAAA,4BAAA,aACc,IAAI,MAAM,IAAI,UAAU,OAAO,EAAE;KAC3C,SAAS,IAAI,WAAW;KACxB,OAAO,IAAI,SAAS;KACrB,CAAC,CACH;;GAEJ,CAAC;GACF;;;;;;;;;;;;;;;;;;;;;;;;;;AC7BJ,SAAgB,aACd,YACA;CACA,MAAM,SAAA,GAAA,IAAA,UAAoB,EAAE,CAAM;CAElC,CAAA,GAAA,kBAAA,SAAQ,WAAW;EACjB,OAAO,OAAO,OAAO,OAAO;EAC5B,aAAa,MAAM;GACnB;CAEF,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCT,SAAgB,YAAY,MAA+B;CACzD,CAAA,GAAA,4BAAA,cAAa,kBAAA,QAAQ,kBAAA,UAAU,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BtC,SAAgB,YAAY,UAAmC;CAC7D,CAAA,GAAA,4BAAA,cAAa,kBAAA,YAAY,kBAAA,YAAY,SAAS;;;;;;;;;;ACwChD,SAAgB,kBACd,YACA,eACA;CACA,MAAM,uBACJ,eAAe,wBAAwB;CACzC,MAAM,SACJ,eAAe,eACf,SAAS,aAAa,YAAY,cAAc;CAClD,MAAM,gBACJ,eAAe,wBACR,IAAI,YAAY;EAAE,OAAO;EAAI,MAAM;EAAM,CAAC;CACnD,MAAM,gBACJ,eAAe,wBAAwB,IAAI,aAAa;CAC1D,MAAM,cACJ,eAAe,iBACb,QACA,IAAI,UAAU;EACZ,OAAO,IAAI;EACX,MAAM;EACN,UAAU;EACV,MAAM;EACP,CAAC;;;;;;;;;;CAWN,MAAM,kBAAuC,QAAQ,QAAQ,YAAY;EAEvE,QAAA,GAAA,6BAAA,YACE,OAAO,GAAG,WAAW;GACnB,MAAM,UAAU,OAAO;GAEvB,OAAO,iBAAA,uBAAuB,MADT,OAAO,SAAS,GAAG,OAAO,EACT,qBAAqB;KAE7D;GACE,GAAG;GACH,MAAM,SAAS,GAAG,QAAQ;IACxB,IAAI,SAAS,aAAa,eAAe;IAEzC,MAAM,eAAe,YAAY;IACjC,MAAM,SAAS,WAAW,GAAG,OAAO;;GAEtC,MAAM,UAAU,MAAM,GAAG,QAAQ;IAC/B,MAAM,eAAe,aAAa;IAClC,MAAM,SAAS,YAAY,MAAM,GAAG,OAAO;;GAE7C,MAAM,QAAQ,KAAK,GAAG,QAAQ;IAC5B,MAAM,eAAe,UAAU,IAAgB;IAC/C,MAAM,SAAS,UAAU,KAAiB,GAAG,OAAO;IAEpD,IAAI,SAAS,WAEX,iBAAiB;KACf,YAAY,IAAgB;MAC5B;;GAGN,MAAM,QAAQ,GAAG,QAAQ;IACvB,IAAI,SAAS,aAAa,eAAe;IAEzC,MAAM,eAAe,WAAW;IAChC,MAAM,SAAS,UAAU,GAAG,OAAO;;GAEtC,CACF;;CAGH,OAAO;;AAoCT,SAAgB,YACd,QAIA,SACwB;CAExB,MAAM,KAAK,SAAS,iBAAiB,SAAS,UAAU;CACxD,QAAA,GAAA,6BAAA,YAAkB,OAAO,GAAG,WAAc;EACxC,MAAM,EAAE,WAAW,MAAM,OAAO,IAAI,GAAG,OAAO;EAC9C,IAAI,CAAC,OAAO,SAAS,OAAO;EAC5B,MAAM,IAAI,MAAM,OAAO,UAAU,OAAO;IACvC,QAAQ;;;;;;;;;;ACnPb,eAAsB,mBACpB,UACA,UACA;CACA,OAAO,IAAI,SAAiB,YAAY;EACtC,IACG,qBAAqB,CACrB,GAAG,SAAS,MAAM,CAClB,UAAU,SAAS,CACnB,oBAAoB,WAAW;GAE9B,QACE,OAAM,KAAK,UAAU;IACnB,MAAM,KAAK,QAAQ;IACnB,KAAK,KAAK,OAAO;IACjB,OAAO,KAAK,SAAS;IACrB,QAAQ,KAAK,UAAU;IACxB,EAAE,CACJ;IACD,CACD,MAAM;GACT"}
|
package/dist/client.d.ts
CHANGED
|
@@ -1,129 +1,8 @@
|
|
|
1
|
-
import { AnyArray, AnyFunction } from '@cloudcome/utils-core/types';
|
|
2
|
-
import { UseRequestOptions, UseRequestOutput, UseRequestOutputFilled } from '@cloudcome/utils-vue/request';
|
|
3
|
-
import { CloudMethodOutput, UniError } from './cloud';
|
|
4
|
-
import { ClientDatabaseOutput } from './database';
|
|
5
|
-
type _ImportObject = UniCloudNamespace.UniCloud['importObject'];
|
|
6
|
-
type _ImportObjectArgs = Parameters<_ImportObject>;
|
|
7
|
-
type _ImportObjectOptions = _ImportObjectArgs[1];
|
|
8
|
-
export type CreateUseCloudObjectOptions = _ImportObjectOptions & {
|
|
9
|
-
/**
|
|
10
|
-
* 模拟云对象,用于单元测试
|
|
11
|
-
* @private
|
|
12
|
-
*/
|
|
13
|
-
_mockServer?: any;
|
|
14
|
-
/**
|
|
15
|
-
* 回退错误信息
|
|
16
|
-
* @default '请求失败'
|
|
17
|
-
*/
|
|
18
|
-
fallbackErrorMessage?: string;
|
|
19
|
-
/**
|
|
20
|
-
* 请求开始前的回调函数
|
|
21
|
-
*/
|
|
22
|
-
onBefore?: () => unknown;
|
|
23
|
-
/**
|
|
24
|
-
* 请求成功后的回调函数
|
|
25
|
-
*/
|
|
26
|
-
onSuccess?: () => unknown;
|
|
27
|
-
/**
|
|
28
|
-
* 请求失败时的回调函数
|
|
29
|
-
* @param err 错误信息
|
|
30
|
-
*/
|
|
31
|
-
onError?: (err: UniError) => unknown;
|
|
32
|
-
/**
|
|
33
|
-
* 请求完成后的回调函数(无论成功或失败都会执行)
|
|
34
|
-
*/
|
|
35
|
-
onAfter?: () => unknown;
|
|
36
|
-
/**
|
|
37
|
-
* 显示加载状态的回调函数,当配置了 showLoading 为 true 时会调用
|
|
38
|
-
*/
|
|
39
|
-
onShowLoading?: () => unknown;
|
|
40
|
-
/**
|
|
41
|
-
* 隐藏加载状态的回调函数,当配置了 showLoading 为 true 时会调用
|
|
42
|
-
*/
|
|
43
|
-
onHideLoading?: () => unknown;
|
|
44
|
-
/**
|
|
45
|
-
* 显示错误信息的回调函数,当配置了 showError 为 true 时会调用
|
|
46
|
-
* @param err 错误信息
|
|
47
|
-
*/
|
|
48
|
-
onShowError?: (err: UniError) => unknown;
|
|
49
|
-
};
|
|
50
|
-
/**
|
|
51
|
-
* 云对象请求函数类型定义
|
|
52
|
-
* @template F 云对象方法函数类型
|
|
53
|
-
* @param input 云对象方法的参数数组
|
|
54
|
-
* @returns 返回云对象方法执行结果的Promise
|
|
55
|
-
*/
|
|
56
|
-
export type CloudObjectRequest = <F extends AnyFunction>(...input: Parameters<F>) => Promise<CloudMethodOutput<ReturnType<F>>>;
|
|
57
|
-
/**
|
|
58
|
-
* 用于调用云对象方法的配置选项类型定义
|
|
59
|
-
* @template I 输入参数类型数组
|
|
60
|
-
* @template O 输出结果类型
|
|
61
|
-
*/
|
|
62
|
-
export type UseCloudMethodOptions<I extends AnyArray, O> = Omit<UseRequestOptions<I, O>, 'onError'> & {
|
|
63
|
-
/**
|
|
64
|
-
* 请求发生错误时的回调函数
|
|
65
|
-
* @param err 错误信息
|
|
66
|
-
* @param inputs 请求输入参数
|
|
67
|
-
*/
|
|
68
|
-
onError?: (err: UniError, ...inputs: I) => unknown;
|
|
69
|
-
/**
|
|
70
|
-
* 是否显示加载状态
|
|
71
|
-
* @default false
|
|
72
|
-
*/
|
|
73
|
-
showLoading?: boolean;
|
|
74
|
-
/**
|
|
75
|
-
* 是否显示错误信息
|
|
76
|
-
* @default false
|
|
77
|
-
*/
|
|
78
|
-
showError?: boolean;
|
|
79
|
-
};
|
|
80
|
-
/**
|
|
81
|
-
* 用于调用云对象方法的hook函数类型定义
|
|
82
|
-
* @template I 输入参数类型数组
|
|
83
|
-
* @template O 输出结果类型
|
|
84
|
-
*/
|
|
85
|
-
export type UseCloudMethod<Api extends Record<string, AnyFunction>> = {
|
|
86
|
-
/**
|
|
87
|
-
* 重载签名:当提供 placeholder 选项时,返回包含初始值的输出类型
|
|
88
|
-
* @param method 云对象方法名
|
|
89
|
-
* @param caller 调用云对象方法的函数
|
|
90
|
-
* @param options 包含 placeholder 的请求配置选项
|
|
91
|
-
* @returns 返回包含初始值的请求输出
|
|
92
|
-
*/
|
|
93
|
-
<K extends keyof Api, I extends AnyArray, O>(method: K, caller: (request: Api[K], ...inputs: I) => Promise<CloudMethodOutput<O>>, options: Omit<UseCloudMethodOptions<I, O>, 'placeholder'> & {
|
|
94
|
-
placeholder: () => O;
|
|
95
|
-
}): UseRequestOutputFilled<I, O>;
|
|
96
|
-
/**
|
|
97
|
-
* 重载签名:当不提供 placeholder 选项时,返回普通输出类型
|
|
98
|
-
* @param method 云对象方法名
|
|
99
|
-
* @param caller 调用云对象方法的函数
|
|
100
|
-
* @param options 可选的请求配置选项
|
|
101
|
-
* @returns 返回普通的请求输出
|
|
102
|
-
*/
|
|
103
|
-
<K extends keyof Api, I extends AnyArray, O>(method: K, caller: (request: Api[K], ...inputs: I) => Promise<CloudMethodOutput<O>>, options?: UseCloudMethodOptions<I, O>): UseRequestOutput<I, O>;
|
|
104
|
-
};
|
|
105
|
-
/**
|
|
106
|
-
* 导入云对象并创建一个用于调用云对象的hook
|
|
107
|
-
* @param objectName 云对象名称
|
|
108
|
-
* @param importOptions 配置选项,包含模拟服务器、回退错误信息等
|
|
109
|
-
* @returns 返回一个可用于调用云对象方法的hook函数
|
|
110
|
-
*/
|
|
111
|
-
export declare function importCloudObject<Api extends Record<string, AnyFunction>>(objectName: _ImportObjectArgs[0], importOptions?: CreateUseCloudObjectOptions): UseCloudMethod<Api>;
|
|
112
|
-
export type UseDatabaseOptions<I extends AnyArray, O> = UseRequestOptions<I, O> & {
|
|
113
|
-
/**
|
|
114
|
-
* 模拟数据库,用于单元测试
|
|
115
|
-
*/
|
|
116
|
-
_mockDatabase?: any;
|
|
117
|
-
};
|
|
118
|
-
/**
|
|
119
|
-
* 创建一个用于调用云数据库的hook
|
|
120
|
-
* @param caller 调用云数据库的函数,接收数据库实例和输入参数,返回Promise
|
|
121
|
-
* @param options 配置选项
|
|
122
|
-
* @returns 返回一个请求hook,用于处理云数据库调用
|
|
123
|
-
*/
|
|
124
|
-
export declare function useDatabase<I extends AnyArray, O>(caller: (db: UniCloud.Database, ...inputs: I) => Promise<ClientDatabaseOutput<O>>, options: Omit<UseDatabaseOptions<I, O>, 'placeholder'> & {
|
|
125
|
-
placeholder: () => O;
|
|
126
|
-
}): UseRequestOutputFilled<I, O>;
|
|
127
|
-
export declare function useDatabase<I extends AnyArray, O>(caller: (db: UniCloud.Database, ...inputs: I) => Promise<ClientDatabaseOutput<O>>, options?: UseDatabaseOptions<I, O>): UseRequestOutput<I, O>;
|
|
128
1
|
export { parseCloudMethodOutput } from './_helpers';
|
|
129
2
|
export type { UniError } from './_types';
|
|
3
|
+
export * from './client/app';
|
|
4
|
+
export * from './client/async';
|
|
5
|
+
export * from './client/message';
|
|
6
|
+
export * from './client/page';
|
|
7
|
+
export * from './client/request';
|
|
8
|
+
export * from './client/ui';
|
package/dist/client.mjs
CHANGED
|
@@ -1,6 +1,347 @@
|
|
|
1
1
|
import { t as parseCloudMethodOutput } from "./_helpers.mjs";
|
|
2
|
+
import { errorAssign } from "@cloudcome/utils-core/error";
|
|
3
|
+
import { _runLifeHook } from "@cloudcome/utils-vue/shared";
|
|
4
|
+
import { onHide, onLoad, onPageHide, onPageShow, onShow, onUnload } from "@dcloudio/uni-app";
|
|
5
|
+
import { reactive, ref } from "vue";
|
|
6
|
+
import { promiseDelay } from "@cloudcome/utils-core/promise";
|
|
7
|
+
import { isString } from "@cloudcome/utils-core/type";
|
|
2
8
|
import { useRequest } from "@cloudcome/utils-vue/request";
|
|
3
|
-
//#region src/client.ts
|
|
9
|
+
//#region src/client/message.ts
|
|
10
|
+
/**
|
|
11
|
+
* 显示 confirm 提示
|
|
12
|
+
* @param text 提示文本
|
|
13
|
+
* @param options 其他选项
|
|
14
|
+
* @returns 提示完成后的 Promise
|
|
15
|
+
*/
|
|
16
|
+
function uniConfirm(text, options) {
|
|
17
|
+
const cancelText = options?.cancelText || "取消";
|
|
18
|
+
const confirmText = options?.confirmText || "确认";
|
|
19
|
+
if (cancelText.length > 4) console.warn("微信小程序内不支持 cancelText 长度超过 4 个字符");
|
|
20
|
+
if (confirmText.length > 4) console.warn("微信小程序内不支持 confirmText 长度超过 4 个字符");
|
|
21
|
+
return new Promise((resolve) => {
|
|
22
|
+
setTimeout(() => {
|
|
23
|
+
uni.showModal({
|
|
24
|
+
title: "请确认",
|
|
25
|
+
content: text,
|
|
26
|
+
showCancel: true,
|
|
27
|
+
confirmText,
|
|
28
|
+
cancelText,
|
|
29
|
+
...options,
|
|
30
|
+
success(result) {
|
|
31
|
+
resolve(result.confirm);
|
|
32
|
+
}
|
|
33
|
+
});
|
|
34
|
+
});
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* 显示 prompt 提示
|
|
39
|
+
* @param text 提示文本
|
|
40
|
+
* @param options 其他选项
|
|
41
|
+
* @returns 提示完成后的 Promise
|
|
42
|
+
*/
|
|
43
|
+
function uniPrompt(text, options) {
|
|
44
|
+
const cancelText = options?.cancelText || "取消";
|
|
45
|
+
const confirmText = options?.confirmText || "确认";
|
|
46
|
+
if (cancelText.length > 4) console.warn("微信小程序内不支持 cancelText 长度超过 4 个字符");
|
|
47
|
+
if (confirmText.length > 4) console.warn("微信小程序内不支持 confirmText 长度超过 4 个字符");
|
|
48
|
+
return new Promise((resolve) => {
|
|
49
|
+
setTimeout(() => {
|
|
50
|
+
uni.showModal({
|
|
51
|
+
title: "请输入",
|
|
52
|
+
content: "",
|
|
53
|
+
placeholderText: text,
|
|
54
|
+
showCancel: true,
|
|
55
|
+
confirmText,
|
|
56
|
+
cancelText,
|
|
57
|
+
editable: true,
|
|
58
|
+
...options,
|
|
59
|
+
success(result) {
|
|
60
|
+
resolve(result.content || "");
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* 显示 alert 提示
|
|
68
|
+
* @param text 提示文本
|
|
69
|
+
* @param options 其他选项
|
|
70
|
+
* @returns 提示完成后的 Promise
|
|
71
|
+
*/
|
|
72
|
+
function uniAlert(text, options) {
|
|
73
|
+
const confirmText = options?.confirmText || "好";
|
|
74
|
+
if (confirmText.length > 4) console.warn("微信小程序内不支持 confirmText 长度超过 4 个字符");
|
|
75
|
+
return new Promise((resolve) => {
|
|
76
|
+
setTimeout(() => {
|
|
77
|
+
uni.showModal({
|
|
78
|
+
title: "提示",
|
|
79
|
+
confirmText,
|
|
80
|
+
cancelText: "",
|
|
81
|
+
...options,
|
|
82
|
+
content: text,
|
|
83
|
+
showCancel: false,
|
|
84
|
+
success() {
|
|
85
|
+
resolve();
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
function uniToast(text, iconOrOptions) {
|
|
92
|
+
const options = {};
|
|
93
|
+
if (isString(iconOrOptions)) options.icon = iconOrOptions;
|
|
94
|
+
else Object.assign(options, iconOrOptions);
|
|
95
|
+
return new Promise((resolve) => {
|
|
96
|
+
setTimeout(async () => {
|
|
97
|
+
uni.showToast({
|
|
98
|
+
title: text,
|
|
99
|
+
duration: 2900,
|
|
100
|
+
icon: options.icon || "none"
|
|
101
|
+
});
|
|
102
|
+
promiseDelay(3e3).then(resolve);
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* 显示 loading 提示
|
|
108
|
+
* @param title 提示文本
|
|
109
|
+
*/
|
|
110
|
+
function uniLoading(title) {
|
|
111
|
+
uni.showLoading({
|
|
112
|
+
title,
|
|
113
|
+
mask: true
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
//#endregion
|
|
117
|
+
//#region src/client/app.ts
|
|
118
|
+
/**
|
|
119
|
+
* 应用显示状态生命周期钩子函数
|
|
120
|
+
*
|
|
121
|
+
* 该函数用于监听应用从后台进入前台的生命周期事件。
|
|
122
|
+
* 当应用从后台切换到前台时触发 onShow 回调,
|
|
123
|
+
* 当应用从前台切换到后台时触发 onHide 回调。
|
|
124
|
+
*
|
|
125
|
+
* @param appShow - 应用显示状态变化时的回调函数,可以返回一个清理函数
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* // 基本用法
|
|
129
|
+
* useAppShow(() => {
|
|
130
|
+
* console.log('应用进入前台');
|
|
131
|
+
*
|
|
132
|
+
* // 可选:返回一个清理函数,在应用进入后台时执行
|
|
133
|
+
* return () => {
|
|
134
|
+
* console.log('应用进入后台');
|
|
135
|
+
* };
|
|
136
|
+
* });
|
|
137
|
+
*
|
|
138
|
+
* @example
|
|
139
|
+
* // 带有异步操作的用法
|
|
140
|
+
* useAppShow(async () => {
|
|
141
|
+
* // 应用进入前台时刷新数据
|
|
142
|
+
* await refreshUserData();
|
|
143
|
+
*
|
|
144
|
+
* // 返回清理函数
|
|
145
|
+
* return () => {
|
|
146
|
+
* // 应用进入后台时保存数据
|
|
147
|
+
* saveUserData();
|
|
148
|
+
* };
|
|
149
|
+
* });
|
|
150
|
+
*/
|
|
151
|
+
function useAppShow(appShow) {
|
|
152
|
+
_runLifeHook(onShow, onHide, appShow);
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* 订阅模板消息
|
|
156
|
+
* @param templateId 模板消息 ID 或 ID 列表
|
|
157
|
+
* @returns Promise<boolean>
|
|
158
|
+
*/
|
|
159
|
+
async function uniSubscribeNotice(templateId) {
|
|
160
|
+
if (!uni.requestSubscribeMessage) return false;
|
|
161
|
+
return new Promise((resolve) => {
|
|
162
|
+
const tmplIds = Array.isArray(templateId) ? templateId : [templateId];
|
|
163
|
+
uni.requestSubscribeMessage({
|
|
164
|
+
tmplIds,
|
|
165
|
+
success(_res) {
|
|
166
|
+
const res = _res;
|
|
167
|
+
let subscribed = false;
|
|
168
|
+
for (const templateId of tmplIds) if (res[templateId] === "accept") {
|
|
169
|
+
subscribed = true;
|
|
170
|
+
break;
|
|
171
|
+
}
|
|
172
|
+
resolve(subscribed);
|
|
173
|
+
},
|
|
174
|
+
fail() {
|
|
175
|
+
resolve(false);
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* 监听应用更新状态
|
|
182
|
+
*/
|
|
183
|
+
function useAppUpdate() {
|
|
184
|
+
const hasUpdate = ref(false);
|
|
185
|
+
const updateReady = ref(false);
|
|
186
|
+
const updateManager = uni.getUpdateManager?.();
|
|
187
|
+
updateManager?.onCheckForUpdate((res) => {
|
|
188
|
+
hasUpdate.value = Boolean(res.hasUpdate);
|
|
189
|
+
});
|
|
190
|
+
updateManager?.onUpdateReady(async () => {
|
|
191
|
+
updateReady.value = true;
|
|
192
|
+
if (!await uniConfirm("新版本已经准备好,是否重启应用?", {
|
|
193
|
+
title: "更新提示",
|
|
194
|
+
confirmText: "重启"
|
|
195
|
+
})) return;
|
|
196
|
+
updateManager.applyUpdate();
|
|
197
|
+
});
|
|
198
|
+
updateManager?.onUpdateFailed(() => {});
|
|
199
|
+
return {
|
|
200
|
+
hasUpdate,
|
|
201
|
+
updateReady
|
|
202
|
+
};
|
|
203
|
+
}
|
|
204
|
+
//#endregion
|
|
205
|
+
//#region src/client/async.ts
|
|
206
|
+
/**
|
|
207
|
+
* 包装 uni 异步函数,返回 Promise 并处理错误
|
|
208
|
+
* @param promise uni 异步函数的 Promise
|
|
209
|
+
* @returns Promise<T>
|
|
210
|
+
* @throws UniPromiseError
|
|
211
|
+
*/
|
|
212
|
+
async function uniPromise(promise) {
|
|
213
|
+
try {
|
|
214
|
+
return await promise;
|
|
215
|
+
} catch (err) {
|
|
216
|
+
const res = err;
|
|
217
|
+
throw errorAssign(new Error(res.errMsg || "未知错误"), {
|
|
218
|
+
errCode: res.errCode || -1,
|
|
219
|
+
errNo: res.errno || -1
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* 包装 uni 异步函数,返回 Promise 并处理错误
|
|
225
|
+
* @param runner uni 异步函数的回调
|
|
226
|
+
* @returns Promise<T>
|
|
227
|
+
* @throws UniPromiseError
|
|
228
|
+
*/
|
|
229
|
+
async function uniCallback(runner) {
|
|
230
|
+
return new Promise((resolve, reject) => {
|
|
231
|
+
runner({
|
|
232
|
+
success(res) {
|
|
233
|
+
resolve(res);
|
|
234
|
+
},
|
|
235
|
+
fail(err) {
|
|
236
|
+
reject(errorAssign(new Error(err.errMsg || "未知错误"), {
|
|
237
|
+
errCode: err.errCode || -1,
|
|
238
|
+
errNo: err.errno || -1
|
|
239
|
+
}));
|
|
240
|
+
}
|
|
241
|
+
});
|
|
242
|
+
});
|
|
243
|
+
}
|
|
244
|
+
//#endregion
|
|
245
|
+
//#region src/client/page.ts
|
|
246
|
+
/**
|
|
247
|
+
* 用于获取页面参数的 hook 函数
|
|
248
|
+
* @template T - 页面参数对象的类型,继承自 AnyObject
|
|
249
|
+
* @param {function} [onPageLoad] - 页面加载时的回调函数
|
|
250
|
+
* @param {T} onLoad.query - 页面参数对象
|
|
251
|
+
* @returns {T} 响应式的页面参数对象
|
|
252
|
+
* @example
|
|
253
|
+
* // 基本用法
|
|
254
|
+
* const query = usePageQuery();
|
|
255
|
+
*
|
|
256
|
+
* // 带回调的用法
|
|
257
|
+
* const query = usePageQuery((query) => {
|
|
258
|
+
* console.log('页面参数:', query);
|
|
259
|
+
* });
|
|
260
|
+
*
|
|
261
|
+
* // 指定参数类型
|
|
262
|
+
* interface PageParams {
|
|
263
|
+
* id: string;
|
|
264
|
+
* name?: string;
|
|
265
|
+
* }
|
|
266
|
+
* const query = usePageQuery<PageParams>();
|
|
267
|
+
*/
|
|
268
|
+
function usePageQuery(onPageLoad) {
|
|
269
|
+
const query = reactive({});
|
|
270
|
+
onLoad((_query) => {
|
|
271
|
+
Object.assign(query, _query);
|
|
272
|
+
onPageLoad?.(query);
|
|
273
|
+
});
|
|
274
|
+
return query;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* 用于处理页面加载生命周期的 hook 函数
|
|
278
|
+
*
|
|
279
|
+
* 该函数会在页面加载时执行传入的回调函数,并在页面卸载时执行清理操作(如果提供了清理函数)。
|
|
280
|
+
* 它是 uni-app 中 onLoad 和 onUnload 生命周期的封装。
|
|
281
|
+
*
|
|
282
|
+
* @param {HookListenerWithDispose} load - 页面加载时的回调函数,可以返回一个清理函数
|
|
283
|
+
*
|
|
284
|
+
* @example
|
|
285
|
+
* // 基本用法
|
|
286
|
+
* usePageLoad(() => {
|
|
287
|
+
* console.log('页面已加载');
|
|
288
|
+
* });
|
|
289
|
+
*
|
|
290
|
+
* @example
|
|
291
|
+
* // 带清理函数的用法
|
|
292
|
+
* usePageLoad(() => {
|
|
293
|
+
* console.log('页面已加载');
|
|
294
|
+
*
|
|
295
|
+
* // 返回一个清理函数,在页面卸载时执行
|
|
296
|
+
* return () => {
|
|
297
|
+
* console.log('页面将要卸载');
|
|
298
|
+
* };
|
|
299
|
+
* });
|
|
300
|
+
*
|
|
301
|
+
* @example
|
|
302
|
+
* // 异步用法
|
|
303
|
+
* usePageLoad(async () => {
|
|
304
|
+
* const data = await fetchData();
|
|
305
|
+
* console.log('获取到数据:', data);
|
|
306
|
+
*
|
|
307
|
+
* return () => {
|
|
308
|
+
* console.log('清理资源');
|
|
309
|
+
* };
|
|
310
|
+
* });
|
|
311
|
+
*/
|
|
312
|
+
function usePageLoad(load) {
|
|
313
|
+
_runLifeHook(onLoad, onUnload, load);
|
|
314
|
+
}
|
|
315
|
+
/**
|
|
316
|
+
* 用于处理页面显示生命周期的 hook 函数
|
|
317
|
+
*
|
|
318
|
+
* 该函数会在页面显示时执行传入的回调函数,并在页面隐藏时执行清理操作(如果提供了清理函数)。
|
|
319
|
+
* 它是 uni-app 中 onPageShow 和 onPageHide 生命周期的封装。
|
|
320
|
+
*
|
|
321
|
+
* @param {HookListenerWithDispose} pageShow - 页面显示时的回调函数,可以返回一个清理函数
|
|
322
|
+
*
|
|
323
|
+
* @example
|
|
324
|
+
* // 基本用法
|
|
325
|
+
* usePageShow(() => {
|
|
326
|
+
* console.log('页面已显示');
|
|
327
|
+
* });
|
|
328
|
+
*
|
|
329
|
+
* @example
|
|
330
|
+
* // 带清理函数的用法
|
|
331
|
+
* usePageShow(() => {
|
|
332
|
+
* console.log('页面已显示');
|
|
333
|
+
*
|
|
334
|
+
* // 返回一个清理函数,在页面隐藏时执行
|
|
335
|
+
* return () => {
|
|
336
|
+
* console.log('页面将要隐藏');
|
|
337
|
+
* };
|
|
338
|
+
* });
|
|
339
|
+
*/
|
|
340
|
+
function usePageShow(pageShow) {
|
|
341
|
+
_runLifeHook(onPageShow, onPageHide, pageShow);
|
|
342
|
+
}
|
|
343
|
+
//#endregion
|
|
344
|
+
//#region src/client/request.ts
|
|
4
345
|
/**
|
|
5
346
|
* 导入云对象并创建一个用于调用云对象的hook
|
|
6
347
|
* @param objectName 云对象名称
|
|
@@ -70,6 +411,26 @@ function useDatabase(caller, options) {
|
|
|
70
411
|
}, options);
|
|
71
412
|
}
|
|
72
413
|
//#endregion
|
|
73
|
-
|
|
414
|
+
//#region src/client/ui.ts
|
|
415
|
+
/**
|
|
416
|
+
* 查询元素距离屏幕的矩形信息
|
|
417
|
+
* @param instance 组件实例
|
|
418
|
+
* @param selector 选择器
|
|
419
|
+
* @returns 元素距离屏幕的矩形信息
|
|
420
|
+
*/
|
|
421
|
+
async function querySelectorRects(instance, selector) {
|
|
422
|
+
return new Promise((resolve) => {
|
|
423
|
+
uni.createSelectorQuery().in(instance.proxy).selectAll(selector).boundingClientRect((_rects) => {
|
|
424
|
+
resolve(_rects.map((rect) => ({
|
|
425
|
+
left: rect.left || 0,
|
|
426
|
+
top: rect.top || 0,
|
|
427
|
+
width: rect.width || 0,
|
|
428
|
+
height: rect.height || 0
|
|
429
|
+
})));
|
|
430
|
+
}).exec();
|
|
431
|
+
});
|
|
432
|
+
}
|
|
433
|
+
//#endregion
|
|
434
|
+
export { importCloudObject, parseCloudMethodOutput, querySelectorRects, uniAlert, uniCallback, uniConfirm, uniLoading, uniPromise, uniPrompt, uniSubscribeNotice, uniToast, useAppShow, useAppUpdate, useDatabase, usePageLoad, usePageQuery, usePageShow };
|
|
74
435
|
|
|
75
436
|
//# sourceMappingURL=client.mjs.map
|