@cloudcome/utils-uni/dist/cloud.cjs.map

cloudcome utils for uni-app

{"version":3,"file":"cloud.cjs","sources":["../src/cloud/module.ts","../src/cloud/respond.ts","../src/cloud/method.ts"],"sourcesContent":["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 type { UniError } from '@/_types';\nimport { errorNormalize } from '@cloudcome/utils-core/error';\nimport type { MaybePromise } from '@cloudcome/utils-core/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-ignore\n      data: null,\n      ...append,\n    };\n  }\n}\n","import { objectDefaults, objectOmit } 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 type z from 'zod';\nimport type { ZodObject } from 'zod';\nimport { createCloudObjectError } from './error';\nimport { parseCloudModuleOutput } from './module';\nimport { respondCloudMethod } from './respond';\nimport type { CloudMethod, CloudModuleOutput, 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   * 用于在云对象响应中添加额外的上下文信息\n   * @param objectThis 云对象上下文\n   * @returns 返回要附加到响应中的数据对象\n   */\n  respondAppend?: (objectThis: CloudObjectThis) => AnyObject;\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 *\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    respondAppend: () => ({}),\n  }) as Required<BuildCloudMethodCreatorOptions>;\n\n  // @ts-ignore\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      // 处理云对象方法响应逻辑，包括错误捕获和统一响应格式\n      return await respondCloudMethod(async () => {\n        const runtimeEnv = this.getCloudInfo().runtimeEnv;\n\n        if (createOptions.onlyLocalEnv && runtimeEnv !== 'local') {\n          throw createCloudObjectError(buildOptions.onlyLocalEnvErrMsg);\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        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      }, 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"],"names":["createCloudObjectError","objectOmit","errorNormalize","objectDefaults","isFunction","tryFlatten"],"mappings":";;;;;;;;AA6BgB,SAAA,uBACd,QACA,uBAAuB,IACQ;AAC/B,MAAI,OAAO,SAAS;AAClB,UAAMA,MAAAA,uBAAuB,OAAO,UAAU,sBAAsB,OAAO,OAAO;AAAA,EAAA;AAEpF,SAAOC,OAAW,WAAA,QAAQ,CAAC,WAAW,QAAQ,CAAC;AACjD;ACjBsB,eAAA,mBACpB,IACA,QAC+B;AAC3B,MAAA;AACI,UAAA,OAAO,MAAM,GAAG;AAEf,WAAA;AAAA,MACL,SAAS;AAAA,MACT,QAAQ;AAAA,MACR;AAAA,MACA,GAAG;AAAA,IACL;AAAA,WACO,KAAK;AACZ,YAAQ,MAAM,0BAA0B;AACxC,YAAQ,MAAM,GAAG;AAEX,UAAA,OAAOC,uBAAe,GAAe;AAEpC,WAAA;AAAA,MACL,SAAS,KAAK,WAAW;AAAA,MACzB,QAAQ,KAAK,UAAU,KAAK,WAAW;AAAA;AAAA,MAEvC,MAAM;AAAA,MACN,GAAG;AAAA,IACL;AAAA,EAAA;AAEJ;AC6EO,SAAS,wBAAwB,SAA0C;AAChF,QAAM,eAAeC,OAAAA,eAAe,WAAW,IAAI;AAAA,IACjD,qBAAqB;AAAA,IACrB,oBAAoB;AAAA,IACpB,oBAAoB;AAAA,IACpB,eAAe,OAAO,CAAC;AAAA,EAAA,CACxB;AAGD,QAAM,oBAAuC,CAAC,MAAM,MAAM,SAAS;AAEjE,UAAM,gBAAiBC,KAAA,WAAW,IAAI,IAAI,OAAO;AAGjD,UAAM,gBAAgBD,OAAAA,eAAe,iBAAiB,IAAI;AAAA,MACxD,cAAc;AAAA,MACd,cAAc;AAAA,IAAA,CACf;AAED,WAAO,eAAgB,OAAO;AAErB,aAAA,MAAM,mBAAmB,YAAY;AACpC,cAAA,aAAa,KAAK,aAAA,EAAe;AAEnC,YAAA,cAAc,gBAAgB,eAAe,SAAS;AAClD,gBAAAH,MAAA,uBAAuB,aAAa,kBAAkB;AAAA,QAAA;AAI9D,cAAM,OAAO,MAAM,iBAAiB,MAAM,SAAS,iBAAiB;AACpE,cAAM,SAAiC;AAAA,UACrC,SAAS;AAAA,UACT;AAAA,QACF;AACA,cAAM,UAAU,OAAO,OAAO,MAAM,MAAM;AAG1C,YAAI,cAAc,gBAAgB,CAAC,KAAK,IAAI;AAC1C,gBAAMA,MAAuB,uBAAA,aAAa,oBAAoB,aAAa,mBAAmB;AAAA,QAAA;AAI5F,YAAAI,KAAAA,WAAW,IAAI,GAAG;AACb,iBAAA,MAAM,KAAK,OAAO;AAAA,QAAA;AAIrB,cAAA,SAAS,KAAK,UAAU,KAAK;AAG/B,YAAA,CAAC,OAAO,SAAS;AACX,kBAAA,IAAI,OAAO,MAAM,MAAM;AAE/B,gBAAM,SAAS,OAAO,OAAO,SAAS,CAAC;AAGvC,cAAI,QAAQ,SAAS,SAAU,OAAM,OAAO;AACtC,gBAAA,IAAI,MAAM,SAAS;AAAA,QAAA;AAI3B,eAAO,MAAM,KAAK,SAAS,OAAO,IAAI;AAAA,MAAA,GACrC,aAAa,cAAc,IAAI,CAAC;AAAA,IACrC;AAAA,EACF;AAEO,SAAA;AACT;AAsBA,eAAe,iBACb,YACA,mBACqC;AACrC,QAAM,aAAyC;AAAA,IAC7C,IAAI;AAAA,IACJ,MAAM,CAAC;AAAA,IACP,YAAY,CAAC;AAAA,IACb,SAAS;AAAA,EACX;AAEI,MAAA,CAAC,kBAA0B,QAAA;AAEzB,QAAA,MAAM,kBAAkB,eAAe;AAAA,IAC3C,YAAY,WAAW,cAAc;AAAA,EAAA,CACtC;AAGD,QAAM,CAAC,MAAM,IAAI,IAAI,MAAMC,KAAA,WAAW,IAAI,WAAW,WAAW,cAAmB,KAAA,EAAE,CAAC;AAClF,MAAA,CAAC,KAAa,QAAA;AAGZ,QAAA,CAAC,MAAM,QAAQ,IAAIA,gBAAW,MAAM,uBAAuB,IAAI,CAAC;AAClE,MAAA,CAAC,SAAiB,QAAA;AAEX,aAAA,KAAK,SAAS,OAAO;AACrB,aAAA,OAAO,SAAS,QAAQ,CAAC;AACzB,aAAA,aAAa,SAAS,cAAc,CAAC;AACrC,aAAA,UAAU,WAAW,KAAK,SAAS,OAAO,KAAK,WAAW,WAAW,WAAW;AAEpF,SAAA;AACT;;;;;;"}