@heybox/hb-sdk-protocol 0.7.5-alpha.0 → 0.8.0-alpha.2

package/dist/index.cjs.js

@@ -12,6 +12,22 @@ const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle
 const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
 const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
 const NETWORK_REQUEST_METHOD = 'network.request';
+const NETWORK_DOWNLOAD_METHOD = 'network.download';
+const FILES_PICK_FILES_METHOD = 'files.pickFiles';
+const FILES_PICK_DIRECTORY_METHOD = 'files.pickDirectory';
+const FILES_SAVE_FILE_METHOD = 'files.saveFile';
+const FILE_CREATE_METHOD = 'file.create';
+const FILE_REMOVE_METHOD = 'file.remove';
+const FILE_EXISTS_METHOD = 'file.exists';
+const FILE_READ_TEXT_METHOD = 'file.readText';
+const FILE_WRITE_TEXT_METHOD = 'file.writeText';
+const FILE_READ_BYTES_METHOD = 'file.readBytes';
+const FILE_WRITE_BYTES_METHOD = 'file.writeBytes';
+const FILE_STAT_METHOD = 'file.stat';
+const DIRECTORY_CREATE_METHOD = 'directory.create';
+const DIRECTORY_REMOVE_METHOD = 'directory.remove';
+const DIRECTORY_EXISTS_METHOD = 'directory.exists';
+const DIRECTORY_LIST_METHOD = 'directory.list';
 const UI_SHOW_TOAST_METHOD = 'ui.showToast';
 const UI_SHOW_LOADING_METHOD = 'ui.showLoading';
 const UI_HIDE_LOADING_METHOD = 'ui.hideLoading';
@@ -62,6 +78,46 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
     { method: STORAGE_GET_STORAGE_METHOD, module: 'storage', capability: STORAGE_GET_STORAGE_METHOD, permission: 'storage.read', risk: 'low' },
     { method: STORAGE_SET_STORAGE_METHOD, module: 'storage', capability: STORAGE_SET_STORAGE_METHOD, permission: 'storage.write', risk: 'medium' },
     { method: NETWORK_REQUEST_METHOD, module: 'network', capability: NETWORK_REQUEST_METHOD, permission: 'network.request', risk: 'high' },
+    { method: NETWORK_DOWNLOAD_METHOD, module: 'network', capability: NETWORK_DOWNLOAD_METHOD, permission: 'network.request', risk: 'high' },
+    { method: FILES_PICK_FILES_METHOD, module: 'files', capability: FILES_PICK_FILES_METHOD, permission: 'files.external', risk: 'high' },
+    {
+        method: FILES_PICK_DIRECTORY_METHOD,
+        module: 'files',
+        capability: FILES_PICK_DIRECTORY_METHOD,
+        permission: 'files.external',
+        risk: 'high',
+    },
+    { method: FILES_SAVE_FILE_METHOD, module: 'files', capability: FILES_SAVE_FILE_METHOD, permission: 'files.external', risk: 'high' },
+    { method: FILE_CREATE_METHOD, module: 'file', capability: FILE_CREATE_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_REMOVE_METHOD, module: 'file', capability: FILE_REMOVE_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_EXISTS_METHOD, module: 'file', capability: FILE_EXISTS_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_READ_TEXT_METHOD, module: 'file', capability: FILE_READ_TEXT_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_WRITE_TEXT_METHOD, module: 'file', capability: FILE_WRITE_TEXT_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_READ_BYTES_METHOD, module: 'file', capability: FILE_READ_BYTES_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_WRITE_BYTES_METHOD, module: 'file', capability: FILE_WRITE_BYTES_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_STAT_METHOD, module: 'file', capability: FILE_STAT_METHOD, permission: 'files.access', risk: 'high' },
+    {
+        method: DIRECTORY_CREATE_METHOD,
+        module: 'directory',
+        capability: DIRECTORY_CREATE_METHOD,
+        permission: 'files.access',
+        risk: 'high',
+    },
+    {
+        method: DIRECTORY_REMOVE_METHOD,
+        module: 'directory',
+        capability: DIRECTORY_REMOVE_METHOD,
+        permission: 'files.access',
+        risk: 'high',
+    },
+    {
+        method: DIRECTORY_EXISTS_METHOD,
+        module: 'directory',
+        capability: DIRECTORY_EXISTS_METHOD,
+        permission: 'files.access',
+        risk: 'high',
+    },
+    { method: DIRECTORY_LIST_METHOD, module: 'directory', capability: DIRECTORY_LIST_METHOD, permission: 'files.access', risk: 'high' },
     { method: UI_SHOW_TOAST_METHOD, module: 'ui', capability: UI_SHOW_TOAST_METHOD, permission: 'ui.toast', risk: 'low' },
     { method: UI_SHOW_LOADING_METHOD, module: 'ui', capability: UI_SHOW_LOADING_METHOD, permission: 'ui.loading', risk: 'low' },
     { method: UI_HIDE_LOADING_METHOD, module: 'ui', capability: UI_HIDE_LOADING_METHOD, permission: 'ui.loading', risk: 'low' },
@@ -126,15 +182,134 @@ const SDK_HANDSHAKE_METHOD = 'sdk.handshake';
 const RUNTIME_LOCATION_PROBE_METHOD = 'runtime.location.probe';
 const SDK_LOCATION_REPORT_METHOD = 'sdk.location.report';
 const SDK_CSP_VIOLATION_METHOD = 'sdk.csp.violation';
+const MINI_PROGRAM_OPERATION_PROGRESS_METHOD = 'operation.progress';
 
 function isMiniProgramBridgeMessage(value) {
-    if (!value || typeof value !== 'object')
+    if (!isRecord$1(value))
+        return false;
+    if (value.namespace !== MINI_PROGRAM_MESSAGE_NAMESPACE || (value.version !== 1 && value.version !== 2) || !isNonEmptyString(value.nonce)) {
         return false;
-    const message = value;
-    return (message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
-        (message.version === 1 || message.version === 2) &&
-        typeof message.nonce === 'string' &&
-        typeof message.type === 'string');
+    }
+    if (value.type === 'handshake') {
+        return isNonEmptyString(value.id) && value.method === SDK_HANDSHAKE_METHOD && value.error === undefined && isSDKHandshakePayload(value.payload);
+    }
+    if (value.type === 'request') {
+        return isNonEmptyString(value.id) && isNonEmptyString(value.method) && value.error === undefined;
+    }
+    if (value.type === 'response') {
+        return (isNonEmptyString(value.id) &&
+            (value.method === undefined || isNonEmptyString(value.method)) &&
+            (value.error === undefined || isBridgeError(value.error)));
+    }
+    if (value.type === 'event') {
+        if (!isNonEmptyString(value.method) || value.error !== undefined)
+            return false;
+        if (value.method === MINI_PROGRAM_OPERATION_PROGRESS_METHOD) {
+            return value.version === 2 && isNonEmptyString(value.id) && isMiniProgramDownloadProgressPayload(value.payload);
+        }
+        return value.id === undefined || isNonEmptyString(value.id);
+    }
+    if (value.type === 'cancel') {
+        return (value.version === 2 && isNonEmptyString(value.id) && value.method === undefined && value.payload === undefined && value.error === undefined);
+    }
+    return false;
+}
+function isMiniProgramRelativePath(value) {
+    if (typeof value !== 'string' || !value || value.startsWith('/') || value.endsWith('/')) {
+        return false;
+    }
+    if (/[\\\u0000-\u001f\u007f]/.test(value))
+        return false;
+    return value.split('/').every((segment) => Boolean(segment) && segment !== '.' && segment !== '..');
+}
+function isMiniProgramPathRootRef(value) {
+    if (!isRecord$1(value))
+        return false;
+    if (value.kind === 'sandbox')
+        return hasOnlyKeys(value, ['kind']);
+    return value.kind === 'directory' && isNonEmptyString(value.handleId) && hasOnlyKeys(value, ['kind', 'handleId']);
+}
+function isMiniProgramFileRef(value) {
+    if (!isRecord$1(value) || value.kind !== 'file')
+        return false;
+    if (isNonEmptyString(value.handleId)) {
+        return hasOnlyKeys(value, ['kind', 'handleId']);
+    }
+    return (isMiniProgramPathRootRef(value.root) && isMiniProgramRelativePath(value.relativePath) && hasOnlyKeys(value, ['kind', 'root', 'relativePath']));
+}
+function isMiniProgramDirectoryRef(value) {
+    if (!isRecord$1(value) || value.kind !== 'directory')
+        return false;
+    if (isNonEmptyString(value.handleId)) {
+        return hasOnlyKeys(value, ['kind', 'handleId']);
+    }
+    return (isMiniProgramPathRootRef(value.root) && isMiniProgramRelativePath(value.relativePath) && hasOnlyKeys(value, ['kind', 'root', 'relativePath']));
+}
+function isMiniProgramFileDescriptor(value) {
+    return (isRecord$1(value) &&
+        value.kind === 'file' &&
+        isNonEmptyString(value.name) &&
+        isFileMode(value.mode) &&
+        isMiniProgramFileRef(value.ref) &&
+        hasOnlyKeys(value, ['kind', 'name', 'mode', 'ref']));
+}
+function isMiniProgramDirectoryDescriptor(value) {
+    return (isRecord$1(value) &&
+        value.kind === 'directory' &&
+        isNonEmptyString(value.name) &&
+        isFileMode(value.mode) &&
+        isMiniProgramDirectoryRef(value.ref) &&
+        hasOnlyKeys(value, ['kind', 'name', 'mode', 'ref']));
+}
+function isMiniProgramFileSystemEntityDescriptor(value) {
+    return isMiniProgramFileDescriptor(value) || isMiniProgramDirectoryDescriptor(value);
+}
+function isMiniProgramByteArray(value) {
+    return value instanceof Uint8Array && value.buffer instanceof ArrayBuffer;
+}
+function isMiniProgramFileStat(value) {
+    return (isRecord$1(value) &&
+        value.kind === 'file' &&
+        isNonNegativeSafeInteger(value.size) &&
+        (value.modifiedAt === undefined || isNonNegativeFiniteNumber(value.modifiedAt)) &&
+        (value.createdAt === undefined || isNonNegativeFiniteNumber(value.createdAt)) &&
+        hasOnlyKeys(value, ['kind', 'size', 'modifiedAt', 'createdAt']));
+}
+function isMiniProgramDownloadProgressPayload(value) {
+    if (!isRecord$1(value) ||
+        !isNonNegativeSafeInteger(value.loaded) ||
+        typeof value.lengthComputable !== 'boolean' ||
+        !hasOnlyKeys(value, ['loaded', 'total', 'lengthComputable'])) {
+        return false;
+    }
+    if (!value.lengthComputable)
+        return value.total === undefined;
+    return isNonNegativeSafeInteger(value.total) && value.loaded <= value.total;
+}
+function isSDKHandshakePayload(value) {
+    return isRecord$1(value) && isNonEmptyString(value.href) && typeof value.userAgent === 'string' && isNonEmptyString(value.sdkVersion);
+}
+function isBridgeError(value) {
+    return isRecord$1(value) && isNonEmptyString(value.code) && typeof value.message === 'string';
+}
+function isFileMode(value) {
+    return value === 'read' || value === 'readwrite';
+}
+function isNonNegativeSafeInteger(value) {
+    return typeof value === 'number' && Number.isSafeInteger(value) && value >= 0;
+}
+function isNonNegativeFiniteNumber(value) {
+    return typeof value === 'number' && Number.isFinite(value) && value >= 0;
+}
+function isNonEmptyString(value) {
+    return typeof value === 'string' && value.length > 0;
+}
+function hasOnlyKeys(value, allowedKeys) {
+    const allowed = new Set(allowedKeys);
+    return Object.keys(value).every((key) => allowed.has(key));
+}
+function isRecord$1(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 
 /** 当前用户信息与登录能力支持的完整 scope 目录。 */
@@ -187,13 +362,30 @@ exports.CLOUD_LEADERBOARD_GET_LIST_METHOD = CLOUD_LEADERBOARD_GET_LIST_METHOD;
 exports.CLOUD_LEADERBOARD_SUBMIT_METHOD = CLOUD_LEADERBOARD_SUBMIT_METHOD;
 exports.DEVICE_SET_CLIPBOARD_METHOD = DEVICE_SET_CLIPBOARD_METHOD;
 exports.DEVICE_VIBRATE_METHOD = DEVICE_VIBRATE_METHOD;
+exports.DIRECTORY_CREATE_METHOD = DIRECTORY_CREATE_METHOD;
+exports.DIRECTORY_EXISTS_METHOD = DIRECTORY_EXISTS_METHOD;
+exports.DIRECTORY_LIST_METHOD = DIRECTORY_LIST_METHOD;
+exports.DIRECTORY_REMOVE_METHOD = DIRECTORY_REMOVE_METHOD;
+exports.FILES_PICK_DIRECTORY_METHOD = FILES_PICK_DIRECTORY_METHOD;
+exports.FILES_PICK_FILES_METHOD = FILES_PICK_FILES_METHOD;
+exports.FILES_SAVE_FILE_METHOD = FILES_SAVE_FILE_METHOD;
+exports.FILE_CREATE_METHOD = FILE_CREATE_METHOD;
+exports.FILE_EXISTS_METHOD = FILE_EXISTS_METHOD;
+exports.FILE_READ_BYTES_METHOD = FILE_READ_BYTES_METHOD;
+exports.FILE_READ_TEXT_METHOD = FILE_READ_TEXT_METHOD;
+exports.FILE_REMOVE_METHOD = FILE_REMOVE_METHOD;
+exports.FILE_STAT_METHOD = FILE_STAT_METHOD;
+exports.FILE_WRITE_BYTES_METHOD = FILE_WRITE_BYTES_METHOD;
+exports.FILE_WRITE_TEXT_METHOD = FILE_WRITE_TEXT_METHOD;
 exports.MINI_PROGRAM_BRIDGE_NONCE_PARAM = MINI_PROGRAM_BRIDGE_NONCE_PARAM;
 exports.MINI_PROGRAM_MESSAGE_NAMESPACE = MINI_PROGRAM_MESSAGE_NAMESPACE;
 exports.MINI_PROGRAM_MESSAGE_VERSION = MINI_PROGRAM_MESSAGE_VERSION;
+exports.MINI_PROGRAM_OPERATION_PROGRESS_METHOD = MINI_PROGRAM_OPERATION_PROGRESS_METHOD;
 exports.MINI_PROGRAM_PROTOCOL_CAPABILITIES = MINI_PROGRAM_PROTOCOL_CAPABILITIES;
 exports.NAVIGATION_CLOSE_METHOD = NAVIGATION_CLOSE_METHOD;
 exports.NAVIGATION_OPEN_APP_PAGE_METHOD = NAVIGATION_OPEN_APP_PAGE_METHOD;
 exports.NAVIGATION_RELOAD_METHOD = NAVIGATION_RELOAD_METHOD;
+exports.NETWORK_DOWNLOAD_METHOD = NETWORK_DOWNLOAD_METHOD;
 exports.NETWORK_REQUEST_METHOD = NETWORK_REQUEST_METHOD;
 exports.RUNTIME_LOCATION_PROBE_METHOD = RUNTIME_LOCATION_PROBE_METHOD;
 exports.SDK_CSP_VIOLATION_METHOD = SDK_CSP_VIOLATION_METHOD;
@@ -215,4 +407,14 @@ exports.VIEWPORT_GET_WINDOW_INFO_METHOD = VIEWPORT_GET_WINDOW_INFO_METHOD;
 exports.VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
 exports.isManagedMiniProgramRuntimePermissionKey = isManagedMiniProgramRuntimePermissionKey;
 exports.isMiniProgramBridgeMessage = isMiniProgramBridgeMessage;
+exports.isMiniProgramByteArray = isMiniProgramByteArray;
+exports.isMiniProgramDirectoryDescriptor = isMiniProgramDirectoryDescriptor;
+exports.isMiniProgramDirectoryRef = isMiniProgramDirectoryRef;
+exports.isMiniProgramDownloadProgressPayload = isMiniProgramDownloadProgressPayload;
+exports.isMiniProgramFileDescriptor = isMiniProgramFileDescriptor;
+exports.isMiniProgramFileRef = isMiniProgramFileRef;
+exports.isMiniProgramFileStat = isMiniProgramFileStat;
+exports.isMiniProgramFileSystemEntityDescriptor = isMiniProgramFileSystemEntityDescriptor;
+exports.isMiniProgramPathRootRef = isMiniProgramPathRootRef;
+exports.isMiniProgramRelativePath = isMiniProgramRelativePath;
 exports.parseMiniProgramRuntimePermissions = parseMiniProgramRuntimePermissions;

package/dist/index.esm.js

@@ -10,6 +10,22 @@ const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle
 const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
 const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
 const NETWORK_REQUEST_METHOD = 'network.request';
+const NETWORK_DOWNLOAD_METHOD = 'network.download';
+const FILES_PICK_FILES_METHOD = 'files.pickFiles';
+const FILES_PICK_DIRECTORY_METHOD = 'files.pickDirectory';
+const FILES_SAVE_FILE_METHOD = 'files.saveFile';
+const FILE_CREATE_METHOD = 'file.create';
+const FILE_REMOVE_METHOD = 'file.remove';
+const FILE_EXISTS_METHOD = 'file.exists';
+const FILE_READ_TEXT_METHOD = 'file.readText';
+const FILE_WRITE_TEXT_METHOD = 'file.writeText';
+const FILE_READ_BYTES_METHOD = 'file.readBytes';
+const FILE_WRITE_BYTES_METHOD = 'file.writeBytes';
+const FILE_STAT_METHOD = 'file.stat';
+const DIRECTORY_CREATE_METHOD = 'directory.create';
+const DIRECTORY_REMOVE_METHOD = 'directory.remove';
+const DIRECTORY_EXISTS_METHOD = 'directory.exists';
+const DIRECTORY_LIST_METHOD = 'directory.list';
 const UI_SHOW_TOAST_METHOD = 'ui.showToast';
 const UI_SHOW_LOADING_METHOD = 'ui.showLoading';
 const UI_HIDE_LOADING_METHOD = 'ui.hideLoading';
@@ -60,6 +76,46 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
     { method: STORAGE_GET_STORAGE_METHOD, module: 'storage', capability: STORAGE_GET_STORAGE_METHOD, permission: 'storage.read', risk: 'low' },
     { method: STORAGE_SET_STORAGE_METHOD, module: 'storage', capability: STORAGE_SET_STORAGE_METHOD, permission: 'storage.write', risk: 'medium' },
     { method: NETWORK_REQUEST_METHOD, module: 'network', capability: NETWORK_REQUEST_METHOD, permission: 'network.request', risk: 'high' },
+    { method: NETWORK_DOWNLOAD_METHOD, module: 'network', capability: NETWORK_DOWNLOAD_METHOD, permission: 'network.request', risk: 'high' },
+    { method: FILES_PICK_FILES_METHOD, module: 'files', capability: FILES_PICK_FILES_METHOD, permission: 'files.external', risk: 'high' },
+    {
+        method: FILES_PICK_DIRECTORY_METHOD,
+        module: 'files',
+        capability: FILES_PICK_DIRECTORY_METHOD,
+        permission: 'files.external',
+        risk: 'high',
+    },
+    { method: FILES_SAVE_FILE_METHOD, module: 'files', capability: FILES_SAVE_FILE_METHOD, permission: 'files.external', risk: 'high' },
+    { method: FILE_CREATE_METHOD, module: 'file', capability: FILE_CREATE_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_REMOVE_METHOD, module: 'file', capability: FILE_REMOVE_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_EXISTS_METHOD, module: 'file', capability: FILE_EXISTS_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_READ_TEXT_METHOD, module: 'file', capability: FILE_READ_TEXT_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_WRITE_TEXT_METHOD, module: 'file', capability: FILE_WRITE_TEXT_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_READ_BYTES_METHOD, module: 'file', capability: FILE_READ_BYTES_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_WRITE_BYTES_METHOD, module: 'file', capability: FILE_WRITE_BYTES_METHOD, permission: 'files.access', risk: 'high' },
+    { method: FILE_STAT_METHOD, module: 'file', capability: FILE_STAT_METHOD, permission: 'files.access', risk: 'high' },
+    {
+        method: DIRECTORY_CREATE_METHOD,
+        module: 'directory',
+        capability: DIRECTORY_CREATE_METHOD,
+        permission: 'files.access',
+        risk: 'high',
+    },
+    {
+        method: DIRECTORY_REMOVE_METHOD,
+        module: 'directory',
+        capability: DIRECTORY_REMOVE_METHOD,
+        permission: 'files.access',
+        risk: 'high',
+    },
+    {
+        method: DIRECTORY_EXISTS_METHOD,
+        module: 'directory',
+        capability: DIRECTORY_EXISTS_METHOD,
+        permission: 'files.access',
+        risk: 'high',
+    },
+    { method: DIRECTORY_LIST_METHOD, module: 'directory', capability: DIRECTORY_LIST_METHOD, permission: 'files.access', risk: 'high' },
     { method: UI_SHOW_TOAST_METHOD, module: 'ui', capability: UI_SHOW_TOAST_METHOD, permission: 'ui.toast', risk: 'low' },
     { method: UI_SHOW_LOADING_METHOD, module: 'ui', capability: UI_SHOW_LOADING_METHOD, permission: 'ui.loading', risk: 'low' },
     { method: UI_HIDE_LOADING_METHOD, module: 'ui', capability: UI_HIDE_LOADING_METHOD, permission: 'ui.loading', risk: 'low' },
@@ -124,15 +180,134 @@ const SDK_HANDSHAKE_METHOD = 'sdk.handshake';
 const RUNTIME_LOCATION_PROBE_METHOD = 'runtime.location.probe';
 const SDK_LOCATION_REPORT_METHOD = 'sdk.location.report';
 const SDK_CSP_VIOLATION_METHOD = 'sdk.csp.violation';
+const MINI_PROGRAM_OPERATION_PROGRESS_METHOD = 'operation.progress';
 
 function isMiniProgramBridgeMessage(value) {
-    if (!value || typeof value !== 'object')
+    if (!isRecord$1(value))
+        return false;
+    if (value.namespace !== MINI_PROGRAM_MESSAGE_NAMESPACE || (value.version !== 1 && value.version !== 2) || !isNonEmptyString(value.nonce)) {
         return false;
-    const message = value;
-    return (message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
-        (message.version === 1 || message.version === 2) &&
-        typeof message.nonce === 'string' &&
-        typeof message.type === 'string');
+    }
+    if (value.type === 'handshake') {
+        return isNonEmptyString(value.id) && value.method === SDK_HANDSHAKE_METHOD && value.error === undefined && isSDKHandshakePayload(value.payload);
+    }
+    if (value.type === 'request') {
+        return isNonEmptyString(value.id) && isNonEmptyString(value.method) && value.error === undefined;
+    }
+    if (value.type === 'response') {
+        return (isNonEmptyString(value.id) &&
+            (value.method === undefined || isNonEmptyString(value.method)) &&
+            (value.error === undefined || isBridgeError(value.error)));
+    }
+    if (value.type === 'event') {
+        if (!isNonEmptyString(value.method) || value.error !== undefined)
+            return false;
+        if (value.method === MINI_PROGRAM_OPERATION_PROGRESS_METHOD) {
+            return value.version === 2 && isNonEmptyString(value.id) && isMiniProgramDownloadProgressPayload(value.payload);
+        }
+        return value.id === undefined || isNonEmptyString(value.id);
+    }
+    if (value.type === 'cancel') {
+        return (value.version === 2 && isNonEmptyString(value.id) && value.method === undefined && value.payload === undefined && value.error === undefined);
+    }
+    return false;
+}
+function isMiniProgramRelativePath(value) {
+    if (typeof value !== 'string' || !value || value.startsWith('/') || value.endsWith('/')) {
+        return false;
+    }
+    if (/[\\\u0000-\u001f\u007f]/.test(value))
+        return false;
+    return value.split('/').every((segment) => Boolean(segment) && segment !== '.' && segment !== '..');
+}
+function isMiniProgramPathRootRef(value) {
+    if (!isRecord$1(value))
+        return false;
+    if (value.kind === 'sandbox')
+        return hasOnlyKeys(value, ['kind']);
+    return value.kind === 'directory' && isNonEmptyString(value.handleId) && hasOnlyKeys(value, ['kind', 'handleId']);
+}
+function isMiniProgramFileRef(value) {
+    if (!isRecord$1(value) || value.kind !== 'file')
+        return false;
+    if (isNonEmptyString(value.handleId)) {
+        return hasOnlyKeys(value, ['kind', 'handleId']);
+    }
+    return (isMiniProgramPathRootRef(value.root) && isMiniProgramRelativePath(value.relativePath) && hasOnlyKeys(value, ['kind', 'root', 'relativePath']));
+}
+function isMiniProgramDirectoryRef(value) {
+    if (!isRecord$1(value) || value.kind !== 'directory')
+        return false;
+    if (isNonEmptyString(value.handleId)) {
+        return hasOnlyKeys(value, ['kind', 'handleId']);
+    }
+    return (isMiniProgramPathRootRef(value.root) && isMiniProgramRelativePath(value.relativePath) && hasOnlyKeys(value, ['kind', 'root', 'relativePath']));
+}
+function isMiniProgramFileDescriptor(value) {
+    return (isRecord$1(value) &&
+        value.kind === 'file' &&
+        isNonEmptyString(value.name) &&
+        isFileMode(value.mode) &&
+        isMiniProgramFileRef(value.ref) &&
+        hasOnlyKeys(value, ['kind', 'name', 'mode', 'ref']));
+}
+function isMiniProgramDirectoryDescriptor(value) {
+    return (isRecord$1(value) &&
+        value.kind === 'directory' &&
+        isNonEmptyString(value.name) &&
+        isFileMode(value.mode) &&
+        isMiniProgramDirectoryRef(value.ref) &&
+        hasOnlyKeys(value, ['kind', 'name', 'mode', 'ref']));
+}
+function isMiniProgramFileSystemEntityDescriptor(value) {
+    return isMiniProgramFileDescriptor(value) || isMiniProgramDirectoryDescriptor(value);
+}
+function isMiniProgramByteArray(value) {
+    return value instanceof Uint8Array && value.buffer instanceof ArrayBuffer;
+}
+function isMiniProgramFileStat(value) {
+    return (isRecord$1(value) &&
+        value.kind === 'file' &&
+        isNonNegativeSafeInteger(value.size) &&
+        (value.modifiedAt === undefined || isNonNegativeFiniteNumber(value.modifiedAt)) &&
+        (value.createdAt === undefined || isNonNegativeFiniteNumber(value.createdAt)) &&
+        hasOnlyKeys(value, ['kind', 'size', 'modifiedAt', 'createdAt']));
+}
+function isMiniProgramDownloadProgressPayload(value) {
+    if (!isRecord$1(value) ||
+        !isNonNegativeSafeInteger(value.loaded) ||
+        typeof value.lengthComputable !== 'boolean' ||
+        !hasOnlyKeys(value, ['loaded', 'total', 'lengthComputable'])) {
+        return false;
+    }
+    if (!value.lengthComputable)
+        return value.total === undefined;
+    return isNonNegativeSafeInteger(value.total) && value.loaded <= value.total;
+}
+function isSDKHandshakePayload(value) {
+    return isRecord$1(value) && isNonEmptyString(value.href) && typeof value.userAgent === 'string' && isNonEmptyString(value.sdkVersion);
+}
+function isBridgeError(value) {
+    return isRecord$1(value) && isNonEmptyString(value.code) && typeof value.message === 'string';
+}
+function isFileMode(value) {
+    return value === 'read' || value === 'readwrite';
+}
+function isNonNegativeSafeInteger(value) {
+    return typeof value === 'number' && Number.isSafeInteger(value) && value >= 0;
+}
+function isNonNegativeFiniteNumber(value) {
+    return typeof value === 'number' && Number.isFinite(value) && value >= 0;
+}
+function isNonEmptyString(value) {
+    return typeof value === 'string' && value.length > 0;
+}
+function hasOnlyKeys(value, allowedKeys) {
+    const allowed = new Set(allowedKeys);
+    return Object.keys(value).every((key) => allowed.has(key));
+}
+function isRecord$1(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 
 /** 当前用户信息与登录能力支持的完整 scope 目录。 */
@@ -177,4 +352,4 @@ function isRecord(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 
-export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, SHARE_COPY_LINK_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_INFO_AUTHORIZATION_SCOPES, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isManagedMiniProgramRuntimePermissionKey, isMiniProgramBridgeMessage, parseMiniProgramRuntimePermissions };
+export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, DIRECTORY_CREATE_METHOD, DIRECTORY_EXISTS_METHOD, DIRECTORY_LIST_METHOD, DIRECTORY_REMOVE_METHOD, FILES_PICK_DIRECTORY_METHOD, FILES_PICK_FILES_METHOD, FILES_SAVE_FILE_METHOD, FILE_CREATE_METHOD, FILE_EXISTS_METHOD, FILE_READ_BYTES_METHOD, FILE_READ_TEXT_METHOD, FILE_REMOVE_METHOD, FILE_STAT_METHOD, FILE_WRITE_BYTES_METHOD, FILE_WRITE_TEXT_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_OPERATION_PROGRESS_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_DOWNLOAD_METHOD, NETWORK_REQUEST_METHOD, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, SHARE_COPY_LINK_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_INFO_AUTHORIZATION_SCOPES, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isManagedMiniProgramRuntimePermissionKey, isMiniProgramBridgeMessage, isMiniProgramByteArray, isMiniProgramDirectoryDescriptor, isMiniProgramDirectoryRef, isMiniProgramDownloadProgressPayload, isMiniProgramFileDescriptor, isMiniProgramFileRef, isMiniProgramFileStat, isMiniProgramFileSystemEntityDescriptor, isMiniProgramPathRootRef, isMiniProgramRelativePath, parseMiniProgramRuntimePermissions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heybox/hb-sdk-protocol",
-  "version": "0.7.5-alpha.0",
+  "version": "0.8.0-alpha.2",
   "description": "Heybox mini-program iframe bridge wire contracts.",
   "sideEffects": false,
   "exports": {
@@ -40,6 +40,7 @@
     "test:types": "tsc -p tsconfig.dts.json --noEmit --pretty false",
     "clean": "rimraf ./dist && rimraf ./types",
     "check:boundary": "node scripts/check-boundary.cjs",
+    "pretest:unit": "pnpm run build:types",
     "test:unit": "NODE_OPTIONS='--conditions=heybox' vitest run",
     "test:watch": "NODE_OPTIONS='--conditions=heybox' vitest"
   }

package/src/bridge.ts

@@ -1,7 +1,7 @@
-import { MINI_PROGRAM_MESSAGE_NAMESPACE } from './constants';
-import type { UserInfoAuthorization } from './payloads';
+import { MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_OPERATION_PROGRESS_METHOD } from './constants';
+import type { DownloadProgressPayload, UserInfoAuthorization } from './payloads';
 
-export type MiniProgramBridgeMessageType = 'handshake' | 'request' | 'response' | 'event';
+export type MiniProgramBridgeMessageType = 'handshake' | 'request' | 'response' | 'event' | 'cancel';
 export type MiniProgramEventName =
   | 'launch'
   | 'ready'
@@ -56,6 +56,24 @@ export interface MiniProgramBridgeMessage<TPayload = unknown> {
   payload?: TPayload;
   error?: MiniProgramBridgeError;
 }
+
+export interface MiniProgramBridgeCancelMessage extends MiniProgramBridgeMessage<never> {
+  version: 2;
+  type: 'cancel';
+  id: string;
+  method?: never;
+  payload?: never;
+  error?: never;
+}
+
+export interface MiniProgramBridgeProgressMessage extends MiniProgramBridgeMessage<DownloadProgressPayload> {
+  version: 2;
+  type: 'event';
+  id: string;
+  method: typeof MINI_PROGRAM_OPERATION_PROGRESS_METHOD;
+  payload: DownloadProgressPayload;
+  error?: never;
+}
 export interface MiniProgramEventPayloadMap {
   launch: { timestamp: number; url?: string };
   ready: { timestamp: number };