@lingxia/types 0.11.1 → 0.12.0

package/dist/testing/public-api.mjs

@@ -0,0 +1,584 @@
+export const LX_API_NAMES = [
+    'app',
+    'appearance',
+    'automation',
+    'chooseDirectory',
+    'chooseFile',
+    'chooseMedia',
+    'compressImage',
+    'compressVideo',
+    'connectWifi',
+    'createVideoContext',
+    'downloadFile',
+    'env',
+    'extractVideoThumbnail',
+    'fs',
+    'getConnectedWifi',
+    'getDeviceInfo',
+    'getImageInfo',
+    'getLocation',
+    'getLxAppInfo',
+    'getNetworkInfo',
+    'getScreenInfo',
+    'getStorage',
+    'getSystemSetting',
+    'getUpdateManager',
+    'getVideoInfo',
+    'getWifiList',
+    'hideToast',
+    'makePhoneCall',
+    'navigateBack',
+    'navigateBackApp',
+    'navigateTo',
+    'navigateToApp',
+    'navigationBar',
+    'onDeviceOrientationChange',
+    'onKeyDown',
+    'onKeyUp',
+    'onNetworkChange',
+    'onWifiConnected',
+    'openExternal',
+    'openFile',
+    'previewMedia',
+    'reLaunch',
+    'redirectTo',
+    'saveImageToPhotosAlbum',
+    'saveVideoToPhotosAlbum',
+    'scanCode',
+    'setDeviceOrientation',
+    'setMoreActions',
+    'share',
+    'shell',
+    'showActionSheet',
+    'showModal',
+    'showToast',
+    'startPullDownRefresh',
+    'startWifi',
+    'stopPullDownRefresh',
+    'stopWifi',
+    'supports',
+    'surface',
+    'switchTab',
+    'tabBar',
+    'terminal',
+    'tray',
+    'uploadFile',
+    'vibrateLong',
+    'vibrateShort',
+];
+const HOST_APP_API = [
+    'autostart',
+    'checkUpdate',
+    'envVersion',
+    'exit',
+    'getBaseInfo',
+    'onDisplayLanguageChange',
+    'screenshot',
+    'setBadge',
+];
+const HOST_APP_RUNTIME_API = HOST_APP_API.filter((name) => name !== 'autostart');
+const AUTOSTART_API = ['isEnabled', 'setEnabled'];
+const APPEARANCE_API = ['get', 'set'];
+const NAVIGATION_BAR_API = ['update'];
+const TAB_BAR_API = ['update'];
+const TERMINAL_API = ['colorSchemes', 'fonts', 'settings', 'windows'];
+const TERMINAL_SETTINGS_API = ['get', 'onChange', 'reset', 'update'];
+const TERMINAL_COLOR_SCHEMES_API = ['createPreview', 'import', 'list'];
+const TERMINAL_FONTS_API = ['list'];
+const TERMINAL_PREVIEW_API = ['clear', 'close', 'show'];
+const WINDOWS_TERMINAL_API = ['install', 'setEnabled', 'status'];
+const ENV_API = ['USER_CACHE_PATH', 'USER_DATA_PATH'];
+const SURFACE_NAMESPACE_API = ['get', 'onContext', 'openDeclared', 'openPage', 'openUrl'];
+const SHELL_API = ['openApp', 'openBuiltin', 'openDeclared', 'reconfigure', 'sidebarActions'];
+const SHELL_SIDEBAR_ACTIONS_API = ['clear', 'remove', 'replace', 'update'];
+const TRAY_API = ['hide', 'onClick', 'setBadge', 'setIcon', 'setMenu', 'setTitle', 'show'];
+const FILE_SYSTEM_API = [
+    'copy',
+    'exists',
+    'file',
+    'mkdir',
+    'readDir',
+    'remove',
+    'rename',
+    'stat',
+    'write',
+];
+const LX_FILE_API = [
+    'arrayBuffer',
+    'base64',
+    'bytes',
+    'exists',
+    'json',
+    'path',
+    'stat',
+    'text',
+];
+const STORAGE_API = ['clear', 'delete', 'get', 'info', 'list', 'set'];
+const UPDATE_MANAGER_API = ['applyUpdate', 'onUpdateFailed', 'onUpdateReady'];
+const VIDEO_CONTEXT_API = [
+    'exitFullScreen',
+    'pause',
+    'play',
+    'requestFullScreen',
+    'seek',
+    'setStreamSource',
+    'stop',
+];
+const AUTOMATION_API = [
+    'browser',
+    'desktop',
+    'device',
+    'lxapp',
+    'lxapps',
+    'shell',
+    'terminal',
+];
+const SHELL_DRIVER_API = ['pins', 'setPin'];
+const TERMINAL_DRIVER_API = ['input', 'newTab', 'setMaximized', 'snapshot', 'split'];
+const LXAPP_DRIVER_API = ['eval', 'info', 'nav', 'page', 'pages', 'surfaceLayout'];
+const LXAPP_MANAGER_API = [
+    'close',
+    'current',
+    'list',
+    'open',
+    'restart',
+    'screenshot',
+    'uninstall',
+    'windows',
+];
+const PAGE_DRIVER_API = [
+    'click',
+    'eval',
+    'fill',
+    'key',
+    'pointer',
+    'press',
+    'query',
+    'screenshot',
+    'scroll',
+    'scrollTo',
+    'type',
+    'waitFor',
+];
+const PAGE_POINTER_API = ['click', 'down', 'drag', 'move', 'scroll', 'up'];
+const PAGE_KEY_API = ['press', 'type'];
+const NAV_DRIVER_API = [
+    'back',
+    'current',
+    'info',
+    'redirect',
+    'relaunch',
+    'stack',
+    'switchTab',
+    'to',
+];
+const DEVICE_DRIVER_API = ['get', 'list', 'set'];
+const BROWSER_DRIVER_API = [
+    'activate',
+    'back',
+    'click',
+    'close',
+    'cookies',
+    'current',
+    'eval',
+    'fill',
+    'forward',
+    'open',
+    'press',
+    'query',
+    'reload',
+    'screenshot',
+    'scroll',
+    'scrollTo',
+    'tabs',
+    'type',
+    'wait',
+];
+const BROWSER_COOKIES_API = ['clear', 'delete', 'list', 'set'];
+const DESKTOP_DRIVER_API = [
+    'app',
+    'ax',
+    'clipboard',
+    'displays',
+    'doctor',
+    'key',
+    'permissions',
+    'pixel',
+    'pointer',
+    'process',
+    'screenshot',
+    'snapshot',
+    'wait',
+    'window',
+    'windows',
+];
+const DESKTOP_POINTER_API = ['click', 'down', 'drag', 'move', 'scroll', 'up'];
+const DESKTOP_KEY_API = ['down', 'press', 'type', 'up'];
+const DESKTOP_WINDOW_API = [
+    'activate',
+    'close',
+    'focus',
+    'maximize',
+    'minimize',
+    'moveTo',
+    'moveToDisplay',
+    'raise',
+    'resize',
+    'restore',
+    'setAlwaysOnTop',
+    'status',
+];
+const DESKTOP_CLIPBOARD_API = ['clear', 'get', 'paste', 'set'];
+const DESKTOP_AX_API = [
+    'collapse',
+    'expand',
+    'focus',
+    'hitTest',
+    'invoke',
+    'query',
+    'scrollIntoView',
+    'select',
+    'setValue',
+    'tree',
+];
+const DESKTOP_WAIT_API = ['ax', 'pixel', 'window'];
+const DESKTOP_APP_API = ['launch', 'quit'];
+const DESKTOP_PROCESS_API = ['kill', 'list'];
+export const LX_RUNTIME_SURFACES = [
+    {
+        name: 'lx',
+        layer: 'logic',
+        expression: 'lx',
+        members: LX_API_NAMES,
+        optionalMembers: ['terminal'],
+        properties: [
+            'app',
+            'appearance',
+            'env',
+            'fs',
+            'navigationBar',
+            'shell',
+            'surface',
+            'tabBar',
+            'terminal',
+            'tray',
+        ],
+    },
+    {
+        name: 'lx.app',
+        layer: 'logic',
+        expression: 'lx.app',
+        members: HOST_APP_RUNTIME_API,
+        properties: ['envVersion'],
+    },
+    {
+        name: 'lx.app.autostart',
+        layer: 'logic',
+        expression: 'lx.app.autostart',
+        members: AUTOSTART_API,
+        optional: true,
+    },
+    {
+        name: 'lx.appearance',
+        layer: 'logic',
+        expression: 'lx.appearance',
+        members: APPEARANCE_API,
+    },
+    {
+        name: 'lx.navigationBar',
+        layer: 'logic',
+        expression: 'lx.navigationBar',
+        members: NAVIGATION_BAR_API,
+    },
+    {
+        name: 'lx.tabBar',
+        layer: 'logic',
+        expression: 'lx.tabBar',
+        members: TAB_BAR_API,
+    },
+    {
+        name: 'lx.terminal',
+        layer: 'logic',
+        expression: 'lx.terminal',
+        members: TERMINAL_API,
+        properties: TERMINAL_API,
+        optional: true,
+    },
+    {
+        name: 'lx.terminal.settings',
+        layer: 'logic',
+        expression: 'lx.terminal?.settings',
+        members: TERMINAL_SETTINGS_API,
+        optional: true,
+    },
+    {
+        name: 'lx.terminal.colorSchemes',
+        layer: 'logic',
+        expression: 'lx.terminal?.colorSchemes',
+        members: TERMINAL_COLOR_SCHEMES_API,
+        optional: true,
+    },
+    {
+        name: 'lx.terminal.fonts',
+        layer: 'logic',
+        expression: 'lx.terminal?.fonts',
+        members: TERMINAL_FONTS_API,
+        optional: true,
+    },
+    {
+        name: 'lx.terminal.windows',
+        layer: 'logic',
+        expression: 'lx.terminal?.windows',
+        members: WINDOWS_TERMINAL_API,
+        optional: true,
+    },
+    {
+        name: 'lx.env',
+        layer: 'logic',
+        expression: 'lx.env',
+        members: ENV_API,
+        properties: ENV_API,
+    },
+    {
+        name: 'lx.surface',
+        layer: 'logic',
+        expression: 'lx.surface',
+        members: SURFACE_NAMESPACE_API,
+    },
+    {
+        name: 'lx.shell',
+        layer: 'logic',
+        expression: 'lx.shell',
+        members: SHELL_API,
+        properties: SHELL_API,
+    },
+    {
+        name: 'lx.shell.sidebarActions',
+        layer: 'logic',
+        expression: 'lx.shell.sidebarActions',
+        members: SHELL_SIDEBAR_ACTIONS_API,
+    },
+    { name: 'lx.tray', layer: 'logic', expression: 'lx.tray', members: TRAY_API },
+    { name: 'lx.fs', layer: 'logic', expression: 'lx.fs', members: FILE_SYSTEM_API },
+    { name: 'Storage', layer: 'logic', expression: 'lx.getStorage()', members: STORAGE_API },
+    { name: 'UpdateManager', layer: 'logic', expression: 'lx.getUpdateManager()', members: UPDATE_MANAGER_API },
+    {
+        name: 'Automation',
+        layer: 'automation',
+        expression: 'lx.automation()',
+        members: AUTOMATION_API,
+        properties: ['browser', 'desktop', 'device', 'lxapps', 'shell', 'terminal'],
+    },
+    { name: 'ShellDriver', layer: 'automation', expression: 'lx.automation().shell', members: SHELL_DRIVER_API },
+    {
+        name: 'TerminalDriver',
+        layer: 'automation',
+        expression: 'lx.automation().terminal',
+        members: TERMINAL_DRIVER_API,
+    },
+    {
+        name: 'LxAppDriver',
+        layer: 'automation',
+        expression: 'lx.automation().lxapp()',
+        members: LXAPP_DRIVER_API,
+        properties: ['nav', 'page'],
+    },
+    {
+        name: 'PageDriver',
+        layer: 'automation',
+        expression: 'lx.automation().lxapp().page',
+        members: PAGE_DRIVER_API,
+        properties: ['key', 'pointer'],
+    },
+    { name: 'PagePointer', layer: 'automation', expression: 'lx.automation().lxapp().page.pointer', members: PAGE_POINTER_API },
+    { name: 'PageKey', layer: 'automation', expression: 'lx.automation().lxapp().page.key', members: PAGE_KEY_API },
+    { name: 'NavDriver', layer: 'automation', expression: 'lx.automation().lxapp().nav', members: NAV_DRIVER_API },
+    { name: 'LxAppManager', layer: 'automation', expression: 'lx.automation().lxapps', members: LXAPP_MANAGER_API },
+    { name: 'DeviceDriver', layer: 'automation', expression: 'lx.automation().device', members: DEVICE_DRIVER_API },
+    {
+        name: 'BrowserDriver',
+        layer: 'automation',
+        expression: 'lx.automation().browser',
+        members: BROWSER_DRIVER_API,
+        properties: ['cookies'],
+    },
+    { name: 'BrowserCookies', layer: 'automation', expression: 'lx.automation().browser.cookies', members: BROWSER_COOKIES_API },
+    {
+        name: 'DesktopDriver',
+        layer: 'automation',
+        expression: 'lx.automation().desktop',
+        members: DESKTOP_DRIVER_API,
+        properties: ['app', 'ax', 'clipboard', 'key', 'pointer', 'process', 'wait', 'window'],
+    },
+    { name: 'DesktopPointer', layer: 'automation', expression: 'lx.automation().desktop.pointer', members: DESKTOP_POINTER_API },
+    { name: 'DesktopKey', layer: 'automation', expression: 'lx.automation().desktop.key', members: DESKTOP_KEY_API },
+    { name: 'DesktopWindow', layer: 'automation', expression: 'lx.automation().desktop.window', members: DESKTOP_WINDOW_API },
+    { name: 'DesktopClipboard', layer: 'automation', expression: 'lx.automation().desktop.clipboard', members: DESKTOP_CLIPBOARD_API },
+    { name: 'DesktopAx', layer: 'automation', expression: 'lx.automation().desktop.ax', members: DESKTOP_AX_API },
+    { name: 'DesktopWait', layer: 'automation', expression: 'lx.automation().desktop.wait', members: DESKTOP_WAIT_API },
+    { name: 'DesktopApp', layer: 'automation', expression: 'lx.automation().desktop.app', members: DESKTOP_APP_API },
+    { name: 'DesktopProcess', layer: 'automation', expression: 'lx.automation().desktop.process', members: DESKTOP_PROCESS_API },
+];
+/** Canonical identifiers used by behavioral automation coverage. */
+export const LX_RUNTIME_CAPABILITY_NAMES = LX_RUNTIME_SURFACES.flatMap(({ name, members }) => (members.map((member) => `${name}.${member}`)));
+/** Canonical identifiers used by runtime shape automation coverage. */
+export const LX_RUNTIME_SHAPE_NAMES = LX_RUNTIME_CAPABILITY_NAMES.map((name) => `shape:${name}`);
+const DOWNLOAD_TASK_API = [
+    'abort',
+    'cancel',
+    'catch',
+    'finally',
+    'next',
+    'pause',
+    'resume',
+    'return',
+    'then',
+    'wait',
+];
+const UPLOAD_TASK_API = ['cancel', 'catch', 'finally', 'next', 'return', 'then', 'wait'];
+const COMPRESS_VIDEO_TASK_API = ['cancel', 'catch', 'finally', 'next', 'return', 'then', 'wait'];
+const HOST_UPDATE_INFO_API = ['apply', 'isForceUpdate', 'releaseNotes', 'size', 'version'];
+const HOST_UPDATE_TASK_API = ['catch', 'finally', 'next', 'return', 'then', 'wait'];
+const PREVIEW_MEDIA_API = ['completed', 'current', 'onChange', 'presented'];
+const PAGE_SURFACE_API = [
+    'alive',
+    'close',
+    'hide',
+    'id',
+    'key',
+    'kind',
+    'onClose',
+    'onHide',
+    'onMessage',
+    'onShow',
+    'postMessage',
+    'realized',
+    'show',
+    'visible',
+];
+const TAB_SURFACE_API = [
+    'activate',
+    'alive',
+    'close',
+    'id',
+    'key',
+    'kind',
+    'onClose',
+    'realized',
+    'scope',
+    'visible',
+];
+const PAGE_MESSAGE_PORT_API = ['onMessage', 'postMessage'];
+export const LX_RETURNED_OBJECT_SURFACES = [
+    {
+        name: 'LxFile',
+        members: LX_FILE_API,
+        properties: ['path'],
+        optionalProperties: [],
+        fixture: 'runtime-safe',
+        factory: 'lx.fs.file',
+    },
+    {
+        name: 'VideoContext',
+        members: VIDEO_CONTEXT_API,
+        properties: [],
+        optionalProperties: [],
+        fixture: 'runtime-safe',
+        factory: 'lx.createVideoContext',
+    },
+    {
+        name: 'DownloadTask',
+        members: DOWNLOAD_TASK_API,
+        properties: [],
+        optionalProperties: [],
+        fixture: 'external-service',
+        factory: 'lx.downloadFile',
+    },
+    {
+        name: 'UploadTask',
+        members: UPLOAD_TASK_API,
+        properties: [],
+        optionalProperties: [],
+        fixture: 'external-service',
+        factory: 'lx.uploadFile',
+    },
+    {
+        name: 'CompressVideoTask',
+        members: COMPRESS_VIDEO_TASK_API,
+        properties: [],
+        optionalProperties: [],
+        fixture: 'external-media',
+        factory: 'lx.compressVideo',
+    },
+    {
+        name: 'HostAppUpdateInfo',
+        members: HOST_UPDATE_INFO_API,
+        properties: ['isForceUpdate', 'releaseNotes', 'size', 'version'],
+        optionalProperties: ['releaseNotes', 'size'],
+        fixture: 'external-service',
+        factory: 'lx.app.checkUpdate().update',
+    },
+    {
+        name: 'HostAppUpdateTask',
+        members: HOST_UPDATE_TASK_API,
+        properties: [],
+        optionalProperties: [],
+        fixture: 'external-service',
+        factory: 'HostAppUpdateInfo.apply',
+    },
+    {
+        name: 'PreviewMediaHandle',
+        members: PREVIEW_MEDIA_API,
+        properties: ['completed', 'current', 'presented'],
+        optionalProperties: [],
+        fixture: 'external-ui',
+        factory: 'lx.previewMedia',
+    },
+    {
+        name: 'PageSurface',
+        members: PAGE_SURFACE_API,
+        properties: ['alive', 'id', 'key', 'kind', 'realized', 'visible'],
+        optionalProperties: ['key'],
+        fixture: 'surface',
+        factory: 'lx.surface.openPage',
+    },
+    {
+        name: 'TabSurface',
+        members: TAB_SURFACE_API,
+        properties: ['alive', 'id', 'key', 'kind', 'realized', 'scope', 'visible'],
+        optionalProperties: ['key'],
+        fixture: 'surface',
+        factory: 'lx.surface.openUrl',
+    },
+    {
+        name: 'PageMessagePort',
+        members: PAGE_MESSAGE_PORT_API,
+        properties: [],
+        optionalProperties: [],
+        fixture: 'navigation',
+        factory: 'lx.navigateTo',
+    },
+];
+/** Canonical identifiers for behavior exercised through objects returned by lx APIs. */
+export const LX_RETURNED_OBJECT_CAPABILITY_NAMES = LX_RETURNED_OBJECT_SURFACES.flatMap(({ name, members }) => (members.map((member) => `${name}.${member}`)));
+export const LX_RETURNED_OBJECT_SHAPE_NAMES = LX_RETURNED_OBJECT_CAPABILITY_NAMES.map((name) => `shape:${name}`);
+/**
+ * Shape coverage a run on any host must prove. A surface marked `optional`, or
+ * a member listed in `optionalMembers`, is absent on hosts that do not build
+ * it — `lx.terminal` ships only inside the bundled Terminal Settings lxapp —
+ * so a suite that skips it has not covered it. Requiring it here would let the
+ * covers gate report a surface nobody touched as proven.
+ */
+export const LX_REQUIRED_RUNTIME_SHAPE_NAMES = [
+    ...LX_RUNTIME_SURFACES.flatMap((surface) => {
+        if ('optional' in surface && surface.optional)
+            return [];
+        const optionalMembers = 'optionalMembers' in surface ? surface.optionalMembers : [];
+        return surface.members
+            .filter((member) => !optionalMembers.includes(member))
+            .map((member) => `shape:${surface.name}.${member}`);
+    }),
+    ...LX_RETURNED_OBJECT_SURFACES
+        .filter(({ fixture }) => fixture === 'runtime-safe')
+        .flatMap(({ name, members }) => members.map((member) => `shape:${name}.${member}`)),
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingxia/types",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "TypeScript type definitions for the LingXia JS API",
   "repository": {
     "type": "git",
@@ -112,6 +112,14 @@
       "import": "./dist/automation/index.js",
       "require": "./dist/automation/index.js"
     },
+    "./automation-test-globals": {
+      "types": "./dist/automation-test-globals.d.ts"
+    },
+    "./testing": {
+      "types": "./dist/testing/public-api.d.ts",
+      "import": "./dist/testing/public-api.mjs",
+      "require": "./dist/testing/public-api.js"
+    },
     "./error": {
       "types": "./dist/error.d.ts",
       "import": "./dist/error.js",
@@ -129,8 +137,9 @@
     "check:logic": "npm run gen:logic -- --check",
     "check:quality": "node scripts/check-generated-quality.mjs",
     "test:types": "tsc -p tests/tsconfig.json",
-    "build": "tsc && mkdir -p dist/generated && cp src/logic-globals.d.ts dist/logic-globals.d.ts && cp src/generated/logic-web.d.ts dist/generated/logic-web.d.ts",
-    "clean": "rm -rf dist",
+    "test:runtime": "npm run build && node tests/error-runtime.mjs",
+    "build": "tsc && node scripts/copy-static-types.mjs",
+    "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
     "prepublishOnly": "npm run clean && npm run build"
   },
   "publishConfig": {