@hyext/types-ext-sdk-hy 3.16.1 → 3.17.0-beta.2

package/index.d.ts

@@ -2240,6 +2240,12 @@ namespace context {
      * @returns 调起成功
      */
     function checkSession(): Promise<void>;
+    /**
+     * 发起支付
+     * @param params - 请求参数
+     * @returns 调起成功
+     */
+    function requestPayment(params: RequestPaymentReq): Promise<void>;
 }
 
 /**
@@ -2877,6 +2883,21 @@ type LoginReq = {
     timeout?: number;
 };
 
+/**
+ * @property timeStamp - 时间戳
+ * @property nonceStr - 随机字符串，长度为32个字符以下
+ * @property package - 下单接口返回
+ * @property signType - 签名算法
+ * @property paySign - 签名
+ */
+type RequestPaymentReq = {
+    timeStamp: number;
+    nonceStr: string;
+    package: string;
+    signType: string;
+    paySign: string;
+};
+
 /**
  * 下载中心
  */
@@ -3305,6 +3326,10 @@ namespace device {
      * @param [params] - 输入参数
      */
     function offOrientationChange(params?: OffOrientationChangeReq): Promise<void>;
+    /**
+     * 获取窗口信息
+     */
+    function getWindowInfo(): Promise<WindowInfo>;
 }
 
 /**
@@ -3596,6 +3621,48 @@ type OffOrientationChangeReq = {
     callback?: OrientationChange;
 };
 
+/**
+ * 安全区域
+ * @property left - 安全区域左上角横坐标
+ * @property right - 安全区域右下角横坐标
+ * @property top - 安全区域左上角纵坐标
+ * @property bottom - 安全区域右下角纵坐标
+ * @property width - 安全区域的宽度，单位逻辑像素
+ * @property height - 安全区域的高度，单位逻辑像素
+ */
+type SafeArea = {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+    width: number;
+    height: number;
+};
+
+/**
+ * 窗口信息
+ * @property screenWidth - 屏幕宽度
+ * @property screenHeight - 屏幕高度
+ * @property isLandscape - 屏幕是否是横屏高度
+ * @property pixelRatio - 设备像素比
+ * @property windowWidth - 可使用窗口宽度，单位 px
+ * @property windowHeight - 可使用窗口高度，单位 px
+ * @property statusBarHeight - 状态栏的高度，单位 px
+ * @property screenTop - 窗口上边缘的 y 值
+ * @property [safeArea] - 在竖屏正方向下的安全区域。部分机型没有安全区域概念，则不返回 safeArea 字段
+ */
+type WindowInfo = {
+    screenWidth: number;
+    screenHeight: number;
+    isLandscape: boolean;
+    pixelRatio: number;
+    windowWidth: number;
+    windowHeight: number;
+    statusBarHeight: number;
+    screenTop: number;
+    safeArea?: SafeArea;
+};
+
 /**
  * 逐步废弃
  */
@@ -4051,6 +4118,281 @@ namespace fs {
      * @returns 调用结果
      */
     function chooseMedia(params: ChooseMediaReq): Promise<void>;
+    /**
+     * 下载文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function downloadFile(params: DownloadFileReq): Promise<void>;
+    /**
+     * 判断文件/目录是否存在
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function access(params: AccessReq): Promise<void>;
+    /**
+     * 同步判断文件/目录是否存在
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function accessSync(params: AccessReq): void;
+    /**
+     * 在文件结尾追加内容
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function appendFile(params: AppendFileReq): Promise<void>;
+    /**
+     * 同步在文件结尾追加内容
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function appendFileSync(params: AppendFileReq): void;
+    /**
+     * 关闭文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function close(params: CloseReq): Promise<void>;
+    /**
+     * 同步关闭文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function closeSync(params: CloseReq): void;
+    /**
+     * 复制文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function copyFile(params: CopyFileReq): Promise<void>;
+    /**
+     * 同步复制文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function copyFileSync(params: CopyFileReq): void;
+    /**
+     * 获取文件信息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function getFileInfo(params: GetFileInfoReq): Promise<GetFileInfoRsp>;
+    /**
+     * 获取该小程序下已保存的本地缓存文件列表
+     * @returns 调用结果
+     */
+    function getSavedFileList(): Promise<GetSavedFileListRsp>;
+    /**
+     * 创建文件夹
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function mkdir(params: MkdirReq): Promise<void>;
+    /**
+     * 创建文件夹
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function mkdirSync(params: MkdirReq): void;
+    /**
+     * 打开文件，返回文件描述符
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function open(params: OpenReq): Promise<OpenRsp>;
+    /**
+     * 打开文件，返回文件描述符
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function openSync(params: OpenReq): OpenRsp;
+    /**
+     * 读文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function read(params: ReadReq): Promise<ReadRsp>;
+    /**
+     * 同步读文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readSync(params: ReadReq): ReadRsp;
+    /**
+     * 读取指定压缩类型的本地文件内容
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readCompressedFile(params: ReadCompressedFileReq): Promise<ReadCompressedFileRsp>;
+    /**
+     * 同步读取指定压缩类型的本地文件内容
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readCompressedFileSync(params: ReadCompressedFileReq): ReadCompressedFileRsp;
+    /**
+     * 读取目录内文件列表
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readdir(params: ReaddirReq): Promise<ReaddirRsp>;
+    /**
+     * 同步读取目录内文件列表
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readdirSync(params: ReaddirReq): ReaddirRsp;
+    /**
+     * 读取文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readFile(params: ReadFileReq): Promise<ReadFileRsp>;
+    /**
+     * 同步读取文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readFileSync(params: ReadFileReq): ReadFileRsp;
+    /**
+     * 读取压缩包内的文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function readZipEntry(params: ReadZipEntryReq): Promise<ReadZipEntryRsp>;
+    /**
+     * 解压文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function unzip(params: UnzipReq): Promise<void>;
+    /**
+     * 删除该小程序下已保存的本地缓存文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function removeSavedFile(params: RemoveSavedFileReq): Promise<void>;
+    /**
+     * 重命名文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function rename(params: RenameReq): Promise<void>;
+    /**
+     * 同步重命名文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function renameSync(params: RenameReq): void;
+    /**
+     * 删除目录
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function rmdir(params: RmdirReq): Promise<void>;
+    /**
+     * 同步删除目录
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function rmdirSync(params: RmdirReq): void;
+    /**
+     * 保存临时文件到本地
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function saveFile(params: SaveFileReq): Promise<SaveFileRsp>;
+    /**
+     * 同步保存临时文件到本地
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function saveFileSync(params: SaveFileReq): SaveFileRsp;
+    /**
+     * 获取文件Stats对象
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function stat(params: StatReq): Promise<StatRsp>;
+    /**
+     * 同步获取文件Stats对象
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function statSync(params: StatReq): StatRsp;
+    /**
+     * 对文件内容进行截断操作
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function truncate(params: TruncateReq): Promise<void>;
+    /**
+     * 同步对文件内容进行截断操作
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function truncateSync(params: TruncateReq): void;
+    /**
+     * 删除文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function unlink(params: UnlinkReq): Promise<void>;
+    /**
+     * 同步删除文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function unlinkSync(params: UnlinkReq): void;
+    /**
+     * 写入文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function write(params: WriteReq): Promise<void>;
+    /**
+     * 同步写入文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function writeSync(params: WriteReq): void;
+    /**
+     * 写文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function writeFile(params: WriteFileReq): Promise<void>;
+    /**
+     * 同步写文件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function writeFileSync(params: WriteFileReq): void;
+    /**
+     * 获取文件的状态信息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function fstat(params: FstatReq): Promise<FstatRsp>;
+    /**
+     * 同步获取文件的状态信息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function fstatSync(params: FstatReq): FstatRsp;
+    /**
+     * 对文件内容进行截断操作
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function ftruncate(params: FtruncateReq): Promise<void>;
+    /**
+     * 同步对文件内容进行截断操作
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function ftruncateSync(params: FtruncateReq): void;
 }
 
 /**
@@ -4179,6 +4521,23 @@ type CleanResParams = {
     reserveMD5List: string[];
 };
 
+/**
+ * 保存进度信息
+ * @property url - 文件url
+ * @property bytesTotal - 文件总大小，单位是字
+ * @property bytesLoaded - 已加载的大小，单位是字节
+ */
+type FileProgressInfo = {
+    url: string;
+    bytesTotal: number;
+    bytesLoaded: number;
+};
+
+/**
+ * @param info - 保存进度信息
+ */
+type SaveFileProgressCallback = (info: FileProgressInfo) => void;
+
 /**
  * 本地文件信息
  * @property status - 状态码，0是成功，非0失败
@@ -4220,12 +4579,14 @@ type SaveFileInfo = {
  * @property fileList - 要保留的资源md5列表，至少传入一个
  * @property [authKeys] - 需要授权的场景值
  * @property callback - 单个文件保存结果回调
+ * @property progressCallback - 单个文件保存进度回调
  */
 type SaveFilesReq = {
     type: string;
     fileList: SaveFileInfo[];
     authKeys?: string[];
     callback: SaveFileCallback;
+    progressCallback: SaveFileProgressCallback;
 };
 
 /**
@@ -4344,6 +4705,392 @@ type ChooseMediaReq = {
     callback: ChooseCallback;
 };
 
+/**
+ * 下载文件参数
+ * @property url - 下载资源的 url
+ * @property [header] - HTTP 请求的 Header
+ * @property [timeout] - 超时时间，单位为毫秒，默认值为 60000 即一分钟
+ * @property [filePath] - 指定文件下载后存储的路径 (本地路径)
+ */
+type DownloadFileReq = {
+    url: string;
+    header?: any;
+    timeout?: number;
+    filePath?: string;
+};
+
+/**
+ * 判断文件/目录是否存在参数
+ * @property path - 要判断是否存在的文件/目录路径 (本地路径)
+ */
+type AccessReq = {
+    path: string;
+};
+
+/**
+ * 在文件结尾追加内容参数
+ * @property filePath - 要追加内容的文件路径 (本地路径)
+ * @property data - 要追加的文本或二进制数据
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ */
+type AppendFileReq = {
+    filePath: string;
+    data: string;
+    encoding?: string;
+};
+
+/**
+ * 关闭文件参数
+ * @property fd - 需要被关闭的文件描述符
+ */
+type CloseReq = {
+    fd: string;
+};
+
+/**
+ * 复制文件参数
+ * @property srcPath - 源文件路径，支持本地路径
+ * @property destPath - 目标文件路径，支持本地路径
+ */
+type CopyFileReq = {
+    srcPath: string;
+    destPath: string;
+};
+
+/**
+ * 文件信息
+ * @property size - 文件大小，以字节为单位
+ * @property digest - 按照传入的 digestAlgorithm 计算得出的的文件摘要
+ */
+type GetFileInfoRsp = {
+    size: number;
+    digest: string;
+};
+
+/**
+ * 获取文件信息参数
+ * @property filePath - 要读取的文件路径 (本地路径)
+ * @property [digestAlgorithm] - 计算文件摘要的算法, md5-md5算法, sha1-sha1算法
+ */
+type GetFileInfoReq = {
+    filePath: string;
+    digestAlgorithm?: string;
+};
+
+/**
+ * 文件信息
+ * @property filePath - 文件路径 (本地路径)
+ * @property size - 本地文件大小，以字节为单位
+ * @property createTime - 文件保存时的时间戳
+ */
+type SavedFileInfo = {
+    filePath: string;
+    size: number;
+    createTime: number;
+};
+
+/**
+ * 获取该小程序下已保存的本地缓存文件列表
+ * @property fileList - 文件列表
+ */
+type GetSavedFileListRsp = {
+    fileList: SavedFileInfo[];
+};
+
+/**
+ * 创建文件夹参数
+ * @property dirPath - 创建的目录路径 (本地路径)
+ * @property [recursive] - 是否在递归创建该目录的上级目录后再创建该目录
+ */
+type MkdirReq = {
+    dirPath: string;
+    recursive?: boolean;
+};
+
+/**
+ * 文件信息
+ * @property fd - 文件描述符
+ */
+type OpenRsp = {
+    fd: string;
+};
+
+/**
+ * 打开文件参数
+ * @property filePath - 文件路径 (本地路径)
+ * @property [flag] - 文件系统标志，默认值: 'r'
+ */
+type OpenReq = {
+    filePath: string;
+    flag?: string;
+};
+
+/**
+ * 文件信息
+ * @property bytesRead - 实际读取的字节数
+ * @property ArrayBuffer - 被写入的缓存区的对象
+ */
+type ReadRsp = {
+    bytesRead: number;
+    ArrayBuffer: any;
+};
+
+/**
+ * 读文件参数
+ * @property fd - 文件描述符
+ * @property arrayBuffer - 数据写入的缓冲区，必须是 ArrayBuffer 实例
+ * @property [offset] - 缓冲区中的写入偏移量，默认0
+ * @property [length] - 要从文件中读取的字节数，默认0
+ * @property [position] - 文件读取的起始位置
+ */
+type ReadReq = {
+    fd: string;
+    arrayBuffer: any;
+    offset?: number;
+    length?: number;
+    position?: number;
+};
+
+/**
+ * 压缩类型的本地文件内容
+ * @property data - 文件内容
+ */
+type ReadCompressedFileRsp = {
+    data: any;
+};
+
+/**
+ * 读取指定压缩类型的本地文件内容参数
+ * @property filePath - 要读取的文件的路径 (本地用户文件或代码包文件)
+ */
+type ReadCompressedFileReq = {
+    filePath: string;
+};
+
+/**
+ * 读取目录内文件列表
+ * @property files - 指定目录下的文件名数组
+ */
+type ReaddirRsp = {
+    files: string[];
+};
+
+/**
+ * 读取目录内文件列表参数
+ * @property dirPath - 要读取的目录路径 (本地路径)
+ */
+type ReaddirReq = {
+    dirPath: string;
+};
+
+/**
+ * 读取文件结果
+ * @property data - 文件数据
+ */
+type ReadFileRsp = {
+    data: any;
+};
+
+/**
+ * 读取文件参数
+ * @property filePath - 要读取的文件的路径 (本地路径)
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property [position] - 从文件指定位置开始读，如果不指定，则从文件头开始读
+ * @property [length] - 指定文件的长度，如果不指定，则读到文件末尾。
+ */
+type ReadFileReq = {
+    filePath: string;
+    encoding?: string;
+    position?: number;
+    length?: number;
+};
+
+/**
+ * 读取压缩包内的文件
+ * @property entries - 文件读取结果，key是文件路径，value是一个对象 FileItem ，表示该文件的读取结果。每个 FileItem 包含 data （文件内容） 和 errMsg （错误信息） 属性。
+ */
+type ReadZipEntryRsp = {
+    entries: any;
+};
+
+/**
+ * 读取压缩包内的文件参数
+ * @property filePath - 要读取的文件的路径 (本地路径)
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property entries - 要读取的压缩包内的文件列表（当传入"all" 时表示读取压缩包内所有文件）
+ */
+type ReadZipEntryReq = {
+    filePath: string;
+    encoding?: string;
+    entries: any;
+};
+
+/**
+ * 解压文件参数
+ * @property zipFilePath - 源文件路径，支持本地路径，只可以是 zip 压缩文件
+ * @property targetPath - 目标目录路径，支持本地路径
+ */
+type UnzipReq = {
+    zipFilePath: string;
+    targetPath: string;
+};
+
+/**
+ * 删除该小程序下已保存的本地缓存文件参数
+ * @property filePath - 需要删除的文件路径 (本地路径)
+ */
+type RemoveSavedFileReq = {
+    filePath: string;
+};
+
+/**
+ * 重命名文件参数
+ * @property oldPath - 源文件路径，支持本地路径
+ * @property newPath - 新文件路径，支持本地路径
+ */
+type RenameReq = {
+    oldPath: string;
+    newPath: string;
+};
+
+/**
+ * 删除目录参数
+ * @property dirPath - 要删除的目录路径 (本地路径)
+ * @property [recursive] - 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。
+ */
+type RmdirReq = {
+    dirPath: string;
+    recursive?: boolean;
+};
+
+/**
+ * 保存临时文件到本地结果
+ * @property savedFilePath - 存储后的文件路径 (本地路径)
+ */
+type SaveFileRsp = {
+    savedFilePath: string;
+};
+
+/**
+ * 保存临时文件到本地参数
+ * @property tempFilePath - 临时存储文件路径 (本地路径)
+ * @property [filePath] - 要存储的文件路径 (本地路径)
+ */
+type SaveFileReq = {
+    tempFilePath: string;
+    filePath?: string;
+};
+
+/**
+ * 文件Stats对象结果
+ * @property stats - 当recursive为false时，res.stats是一个Stats对象。当recursive为true且path是一个目录的路径时，res.stats是一个Array，数组的每一项是一个对象，每个对象包含path和stats
+ */
+type StatRsp = {
+    stats: any;
+};
+
+/**
+ * 获取文件Stats对象参数
+ * @property path - 文件/目录路径 (本地路径)
+ * @property [recursive] - 是否递归获取目录下的每个文件的 Stats 信息
+ */
+type StatReq = {
+    path: string;
+    recursive?: boolean;
+};
+
+/**
+ * 对文件内容进行截断操作参数
+ * @property filePath - 要截断的文件路径 (本地路径)
+ * @property [length] - 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）
+ */
+type TruncateReq = {
+    filePath: string;
+    length?: number;
+};
+
+/**
+ * 删除文件参数
+ * @property filePath - 要删除的文件路径 (本地路径)
+ */
+type UnlinkReq = {
+    filePath: string;
+};
+
+/**
+ * 写文件参数
+ * @property fd - 文件描述符
+ * @property data - 要写入的文本或二进制数据
+ * @property [offset] - 在 data 是 ArrayBuffer 时要写入的 arrayBuffer 中的索引，默认0
+ * @property [length] - 在 data 是 ArrayBuffer 时指定要写入的字节数
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
+ * @property [position] - 指定文件开头的偏移量，即数据要被写入的位置
+ */
+type WriteReq = {
+    fd: string;
+    data: string;
+    offset?: number;
+    length?: number;
+    encoding?: string;
+    position?: number;
+};
+
+/**
+ * 写文件参数
+ * @property filePath - 要写入的文件路径 (本地路径)
+ * @property data - 要写入的文本或二进制数据
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
+ */
+type WriteFileReq = {
+    filePath: string;
+    data: string;
+    encoding?: string;
+};
+
+/**
+ * 文件状态
+ * @property mode - 文件的类型和存取的权限
+ * @property size - 文件大小，单位：B
+ * @property lastAccessedTime - 文件最近一次被存取或被执行的时间戳
+ * @property lastModifiedTime - 文件最后一次被修改的时间戳
+ * @property isDirectory - 判断当前文件是否一个目录
+ * @property isFile - 判断当前文件是否一个普通文件
+ */
+type FileStats = {
+    mode: number;
+    size: number;
+    lastAccessedTime: number;
+    lastModifiedTime: number;
+    isDirectory: boolean;
+    isFile: boolean;
+};
+
+/**
+ * 获取文件的状态信息参数
+ * @property stats - 文件状态
+ */
+type FstatRsp = {
+    stats: FileStats;
+};
+
+/**
+ * 获取文件的状态信息参数
+ * @property fd - 文件描述符
+ */
+type FstatReq = {
+    fd: string;
+};
+
+/**
+ * 对文件内容进行截断操作参数
+ * @property fd - 文件描述符
+ * @property length - 截断位置，默认0，如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）
+ */
+type FtruncateReq = {
+    fd: string;
+    length: number;
+};
+
 /**
  * 游戏相关
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyext/types-ext-sdk-hy",
-  "version": "3.16.1",
+  "version": "3.17.0-beta.2",
   "description": "TypeScript definitions for sdk",
   "types": "./index.d.ts",
   "main": "",