@ray-js/api 1.7.82 → 1.7.83

package/@types/api-extend.d.ts

@@ -1,110 +1,103 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-type OriginRequestCloudParams = Parameters<typeof ty.apiRequestByAtop>[0]
+type OriginRequestCloudParams = Parameters<typeof ty.apiRequestByAtop>[0];
 type RequestCloudParams = Omit<OriginRequestCloudParams, 'postData'> & {
-  data: OriginRequestCloudParams['postData']
-}
-type RequestCloudReturn = ReturnType<typeof ty.apiRequestByAtop>
+  data: OriginRequestCloudParams['postData'];
+};
+type RequestCloudReturn = ReturnType<typeof ty.apiRequestByAtop>;
 
-type IAnyObject = Record<string, any>
+type IAnyObject = Record<string, any>;
 /** 启动参数 */
 interface LaunchOptionsApp {
   /** 启动小程序的路径 (代码包路径) */
-  path: string
+  path: string;
   /** 启动小程序的 query 参数 */
-  query: IAnyObject
-  [key: string]: any
+  query: IAnyObject;
+  [key: string]: any;
 }
 interface GeneralCallbackResult {
-  [key: string]: any
+  [key: string]: any;
 }
 /** 小程序切前台事件的监听函数 */
 type OnAppShowListeners = (
   /** 启动参数 */
-  options?: LaunchOptionsApp
-) => void
+  options?: LaunchOptionsApp,
+) => void;
 
-type OnThemeChangelisteners = (result: OnThemeChangeListenerResult) => void
-type OffThemeChangelisteners = (result: OnThemeChangeListenerResult) => void
-type OnWindowResizeListeners = (result: OnWindowResizeListenerResult) => void
-type OffWindowResizeListeners = (result: OnWindowResizeListenerResult) => void
+type OnThemeChangelisteners = (result: OnThemeChangeListenerResult) => void;
+type OffThemeChangelisteners = (result: OnThemeChangeListenerResult) => void;
+type OnWindowResizeListeners = (result: OnWindowResizeListenerResult) => void;
+type OffWindowResizeListeners = (result: OnWindowResizeListenerResult) => void;
 
 interface OnWindowResizeListenerResult {
-  type: string
-  size: { windowWidth: number; windowHeight: number }
+  type: string;
+  size: { windowWidth: number; windowHeight: number };
 }
 
 interface Callback {
-  success?: (res?: any) => void
-  fail?: (res?: any) => void
-  complete?: (res?: any) => void
+  success?: (res?: any) => void;
+  fail?: (res?: any) => void;
+  complete?: (res?: any) => void;
 }
 interface PageScrollToProps extends Callback {
-  scrollTop?: number
-  duration?: number
-  selector?: string
+  scrollTop?: number;
+  duration?: number;
+  selector?: string;
 }
 
 interface CreateAnimationProps {
-  duration: number
-  timingFunction:
-    | 'linear'
-    | 'ease'
-    | 'ease-in'
-    | 'ease-out'
-    | 'ease-in-out'
-    | 'step-start'
-    | 'step-end'
-  delay: number
-  transformOrigin: string
+  duration: number;
+  timingFunction: 'linear' | 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'step-start' | 'step-end';
+  delay: number;
+  transformOrigin: string;
 }
 
 interface NodesRef {
-  fields(e: any, t: any): SelectorQuery
-  boundingClientRect(e?: any): SelectorQuery
-  scrollOffset(e?: any): SelectorQuery
+  fields(e: any, t: any): SelectorQuery;
+  boundingClientRect(e?: any): SelectorQuery;
+  scrollOffset(e?: any): SelectorQuery;
 }
 interface SelectorQuery {
-  select: (e: any) => NodesRef
-  selectAll: (e: any) => NodesRef
-  selectViewport: () => NodesRef
-  exec: (e: any) => void
+  select: (e: any) => NodesRef;
+  selectAll: (e: any) => NodesRef;
+  selectViewport: () => NodesRef;
+  exec: (e: any) => void;
 }
 
 interface CreateIntersectionObserverProps {
-  thresholds?: number[]
-  initialRatio?: number
-  observeAll?: boolean
+  thresholds?: number[];
+  initialRatio?: number;
+  observeAll?: boolean;
 }
 
 interface IntersectionMargin {
-  left?: number
-  right?: number
-  bottom?: number
-  top?: number
+  left?: number;
+  right?: number;
+  bottom?: number;
+  top?: number;
 }
 
 interface IntersectionObserveRect {
-  left?: number
-  right?: number
-  bottom?: number
-  top?: number
-  width?: number
-  height?: number
+  left?: number;
+  right?: number;
+  bottom?: number;
+  top?: number;
+  width?: number;
+  height?: number;
 }
 interface IntersectionObserveCbParam {
-  id: string
-  dataset: Record<string, any>
-  intersectionRatio: number
-  intersectionRect: IntersectionObserveRect
-  boundingClientRect: IntersectionObserveRect
-  relativeRect: IntersectionObserveRect
-  time: number
+  id: string;
+  dataset: Record<string, any>;
+  intersectionRatio: number;
+  intersectionRect: IntersectionObserveRect;
+  boundingClientRect: IntersectionObserveRect;
+  relativeRect: IntersectionObserveRect;
+  time: number;
 }
 interface IntersectionObserver {
-  observe(targetSelector: string, cb: (e: IntersectionObserveCbParam) => void): IntersectionObserver
-  disconnect(): void
-  relativeTo(selector: string, margin: IntersectionMargin): IntersectionObserver
-  relativeToViewport(margin: IntersectionMargin): IntersectionObserver
+  observe(targetSelector: string, cb: (e: IntersectionObserveCbParam) => void): IntersectionObserver;
+  disconnect(): void;
+  relativeTo(selector: string, margin: IntersectionMargin): IntersectionObserver;
+  relativeToViewport(margin: IntersectionMargin): IntersectionObserver;
 }
 
 interface OnThemeChangeListenerResult {
@@ -113,80 +106,80 @@ interface OnThemeChangeListenerResult {
    * 可选值：
    * - 'dark': 深色主题;
    * - 'light': 浅色主题; */
-  theme: 'dark' | 'light'
+  theme: 'dark' | 'light';
 }
 
 interface setNavigationBarBackParam {
-  type: 'system' | 'custom'
+  type: 'system' | 'custom';
 }
 
 interface CanvasGetImageDataProps extends Callback {
-  canvasId: string
-  x: number
-  y: number
-  width: number
-  height: number
-  success(res: { width: number; height: number; data: Array }): void
+  canvasId: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  success(res: { width: number; height: number; data: Array }): void;
 }
 
 interface CanvasPutImageDataProps extends Callback {
-  canvasId: string
-  x: number
-  y: number
-  width: number
-  height: number
-  data: Array
+  canvasId: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  data: Array;
 }
 
 interface VideoContext {
-  play(): void
-  pause(): void
-  stop(): void
-  playbackRate(rate: number): void
-  seek(position: number): void
-  sendDanmu(data: { text: string; color: string }): void
+  play(): void;
+  pause(): void;
+  stop(): void;
+  playbackRate(rate: number): void;
+  seek(position: number): void;
+  sendDanmu(data: { text: string; color: string }): void;
 }
 
 interface NativeVideoContext {
-  play(): void
-  pause(): void
-  stop(): void
-  playbackRate(rate: number): void
-  seek(position: number): void
+  play(): void;
+  pause(): void;
+  stop(): void;
+  playbackRate(rate: number): void;
+  seek(position: number): void;
 }
 
 interface AddMarker extends Callback {
-  markers: any[]
-  clear?: boolean
+  markers: any[];
+  clear?: boolean;
 }
 interface RemoveMarkers extends Callback {
-  markerIds: string[]
-  clear?: boolean
+  markerIds: string[];
+  clear?: boolean;
 }
 interface GetScale extends Callback {
-  success({ scale: number }): void
+  success({ scale: number }): void;
 }
 interface GetCenterLocation extends Callback {
-  iconPath?: string
-  clear?: boolean
-  success({ longitude: number, latitude: number }): void
+  iconPath?: string;
+  clear?: boolean;
+  success({ longitude: number, latitude: number }): void;
 }
 interface MoveToLocation extends Callback {
-  longitude: number
-  latitude: number
+  longitude: number;
+  latitude: number;
 }
 interface MoveAlong extends Callback {
-  markerId: number
-  path: Array<{ longitude: number; latitude: number }>
-  duration: number
+  markerId: number;
+  path: Array<{ longitude: number; latitude: number }>;
+  duration: number;
 }
 interface MapContext {
-  addMarkers(data: AddMarker): void
-  removeMarkers(data: RemoveMarkers): void
-  getScale(data: GetScale): void
-  getCenterLocation(data: GetCenterLocation): void
-  moveToLocation(data: MoveToLocation): void
-  moveAlong(data: MoveAlong): void
+  addMarkers(data: AddMarker): void;
+  removeMarkers(data: RemoveMarkers): void;
+  getScale(data: GetScale): void;
+  getCenterLocation(data: GetCenterLocation): void;
+  moveToLocation(data: MoveToLocation): void;
+  moveAlong(data: MoveAlong): void;
 }
 
 interface IpcContext {
@@ -210,6 +203,7 @@ interface IpcContext {
   setPTZControllable(res: Callback & { pTZControllable?: 0 | 1 }): void;
   closeFloatingWindow(res?: Callback): void;
   openFloatingWindow(res?: Callback): void;
+  showSmallMonitor(res: Callback & { show: boolean }): void;
   getVideoInfo(res?: Callback): void;
   isMuted(res?: Callback): void;
   isConnected(res?: Callback): void;
@@ -265,17 +259,17 @@ interface IpcContext {
       verticalStripAspect: number;
     },
   ): void;
-  /** 
+  /**
    * 设置是否锁定 VR 球面画面（重力感应）
    * @param options.locked - 是否锁定重力感应
    */
   setVRViewLocked(options: Callback & { locked: boolean }): void;
-  /** 
-   * 获取 VR 球面画面锁定状态 
+  /**
+   * 获取 VR 球面画面锁定状态
    */
   getVRViewLocked(options: Callback): void;
-  /** 
-   * 图片展示（VR） 
+  /**
+   * 图片展示（VR）
    * @param options.path - 图片远程路径
    * @param options.encryptKey - 图片加密 key
    */
@@ -285,49 +279,44 @@ interface IpcContext {
 interface CameraContext {
   takePhoto(
     res: Callback & {
-      quality?: 'normal' | 'high' | 'low'
-      success(res: { tempImagePath: string }): void
-    }
-  ): void
-  setZoom(res: Callback & { zoom: number; success(res: { zoom: number }): void }): void
+      quality?: 'normal' | 'high' | 'low';
+      success(res: { tempImagePath: string }): void;
+    },
+  ): void;
+  setZoom(res: Callback & { zoom: number; success(res: { zoom: number }): void }): void;
 }
 
 interface WebviewContext {
-  postMessage(options: { data: Record<string, any> }): void
-  reload(options: Callback): void
+  postMessage(options: { data: Record<string, any> }): void;
+  reload(options: Callback): void;
 }
 
 interface SocketTask {
-  send(option: {
-    data: string | ArrayBuffer
-    success?: () => void
-    fail?: () => void
-    complete?: () => void
-  }): void
+  send(option: { data: string | ArrayBuffer; success?: () => void; fail?: () => void; complete?: () => void }): void;
   close(option: {
-    code?: number
-    reason?: string
-    success?: () => void
-    fail?: () => void
-    complete?: () => void
-  }): void
-  onOpen(callback: () => void): void
-  onClose(callback: () => void): void
-  onError(callback: () => void): void
-  onMessage(callback: (res: { data: string | ArrayBuffer }) => void): void
+    code?: number;
+    reason?: string;
+    success?: () => void;
+    fail?: () => void;
+    complete?: () => void;
+  }): void;
+  onOpen(callback: () => void): void;
+  onClose(callback: () => void): void;
+  onError(callback: () => void): void;
+  onMessage(callback: (res: { data: string | ArrayBuffer }) => void): void;
 }
 
 interface ConnectSocketProps {
-  url: string
-  protocols?: string[]
-  header?: Record<string, string>
-  timeout?: number
-  tcpNoDelay?: boolean
-  perMessageDeflate?: boolean
-  forceCellularNetwork?: boolean
-  success?: () => void
-  fail?: () => void
-  complete?: () => void
+  url: string;
+  protocols?: string[];
+  header?: Record<string, string>;
+  timeout?: number;
+  tcpNoDelay?: boolean;
+  perMessageDeflate?: boolean;
+  forceCellularNetwork?: boolean;
+  success?: () => void;
+  fail?: () => void;
+  complete?: () => void;
 }
 
 declare namespace ty {
@@ -337,7 +326,7 @@ declare namespace ty {
    * @since xxx@1.2.10
    * @plugin xxx@1.1.2
    */
-  export function requestCloud(params: RequestCloudParams): RequestCloudReturn
+  export function requestCloud(params: RequestCloudParams): RequestCloudReturn;
 
   /**
    * 请求小程序
@@ -345,59 +334,57 @@ declare namespace ty {
    * @since xxx@1.2.10
    * @plugin xxx@1.1.2
    */
-  export function requestCloud<T>(params: RequestCloudParams): Promise<T>
+  export function requestCloud<T>(params: RequestCloudParams): Promise<T>;
 
-  export function onAppShow(listeners: OnAppShowListeners)
-  export function offAppShow(listeners?: (res: GeneralCallbackResult) => void)
-  export function onAppHide(listener: (res: GeneralCallbackResult) => void)
-  export function offAppHide(listeners?: (res: GeneralCallbackResult) => void)
-  export function onWindowResize(listeners: OnWindowResizeListeners)
-  export function offWindowResize(listeners?: OffWindowResizeListeners)
+  export function onAppShow(listeners: OnAppShowListeners);
+  export function offAppShow(listeners?: (res: GeneralCallbackResult) => void);
+  export function onAppHide(listener: (res: GeneralCallbackResult) => void);
+  export function offAppHide(listeners?: (res: GeneralCallbackResult) => void);
+  export function onWindowResize(listeners: OnWindowResizeListeners);
+  export function offWindowResize(listeners?: OffWindowResizeListeners);
   export function onError(
     listeners: (
       /** 错误信息，包含堆栈 */
-      error?: string
-    ) => void
-  )
-  export function offError(listeners?: (res: GeneralCallbackResult) => void)
-  export function onAppEvent(listener: (res: GeneralCallbackResult) => void)
-  export function offAppEvent(listener?: (res: GeneralCallbackResult) => void)
-  export function onThemeChange(listener: OnThemeChangelisteners)
-  export function offThemeChange(listener?: OffThemeChangelisteners)
-  export function onPageNotFound(listeners: ({ url: string, query: CommonObject }) => void)
-  export function onNavigationBarBack(callback: (res?: any) => void)
-  export function offNavigationBarBack(callback: (res?: any) => void)
-  export function setNavigationBarBack(param: setNavigationBarBackParam)
+      error?: string,
+    ) => void,
+  );
+  export function offError(listeners?: (res: GeneralCallbackResult) => void);
+  export function onAppEvent(listener: (res: GeneralCallbackResult) => void);
+  export function offAppEvent(listener?: (res: GeneralCallbackResult) => void);
+  export function onThemeChange(listener: OnThemeChangelisteners);
+  export function offThemeChange(listener?: OffThemeChangelisteners);
+  export function onPageNotFound(listeners: ({ url: string, query: CommonObject }) => void);
+  export function onNavigationBarBack(callback: (res?: any) => void);
+  export function offNavigationBarBack(callback: (res?: any) => void);
+  export function setNavigationBarBack(param: setNavigationBarBackParam);
   /**
    * 0.10.3
    */
-  export function createAnimation(param: CreateAnimationProps): IAnimation
-  export function pageScrollTo(param: PageScrollToProps): void
-  export function createSelectorQuery(): SelectorQuery
-  export function createIntersectionObserver(
-    param: CreateIntersectionObserverProps
-  ): IntersectionObserver
-  export function createCanvasContext(canvasId: string): any
-  export function canvasGetImageData(param: CanvasGetImageDataProps): void
-  export function canvasPutImageData(param: CanvasPutImageDataProps): void
-  export function createVideoContext(id: string): VideoContext
-  export function createNativeVideoContext(id: string): NativeVideoContext
-  export function createMapContext(mapId: string): MapContext
-  export function createIpcPlayerContext(deviceId: string): IpcContext
-  export function createCameraContext(): CameraContext
-  export function createWebviewContext(mapId: string): WebviewContext
+  export function createAnimation(param: CreateAnimationProps): IAnimation;
+  export function pageScrollTo(param: PageScrollToProps): void;
+  export function createSelectorQuery(): SelectorQuery;
+  export function createIntersectionObserver(param: CreateIntersectionObserverProps): IntersectionObserver;
+  export function createCanvasContext(canvasId: string): any;
+  export function canvasGetImageData(param: CanvasGetImageDataProps): void;
+  export function canvasPutImageData(param: CanvasPutImageDataProps): void;
+  export function createVideoContext(id: string): VideoContext;
+  export function createNativeVideoContext(id: string): NativeVideoContext;
+  export function createMapContext(mapId: string): MapContext;
+  export function createIpcPlayerContext(deviceId: string): IpcContext;
+  export function createCameraContext(): CameraContext;
+  export function createWebviewContext(mapId: string): WebviewContext;
   export type env = {
-    USER_DATA_PATH: string
-  }
-  export function connectSocket(param: ConnectSocketProps): SocketTask
+    USER_DATA_PATH: string;
+  };
+  export function connectSocket(param: ConnectSocketProps): SocketTask;
 
-  type IRegionCode = 'AY' | 'AZ' | 'EU' | 'IN' | 'UE' | 'WE' | 'RU'
+  type IRegionCode = 'AY' | 'AZ' | 'EU' | 'IN' | 'UE' | 'WE' | 'RU';
 
   /**
    * 获取当前小程序的区域码
    * @returns 区域码 可选值：AY, AZ, EU, IN, RU, UE, WE
    */
-  export function getRegionCode(): IRegionCode
+  export function getRegionCode(): IRegionCode;
 
   /**
    * @description对页面内的唯一元素进行截图
@@ -413,28 +400,28 @@ declare namespace ty {
    * 注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
    */
   export function snapshot(params: {
-    selector?: string
-    backgroundColor?: string
-    format?: string
-    quality?: number
+    selector?: string;
+    backgroundColor?: string;
+    format?: string;
+    quality?: number;
     success?: (params: {
       /** 截图的临时文件路径 */
-      tempFilePath: string
-    }) => void
+      tempFilePath: string;
+    }) => void;
     fail?: (params: {
-      errorMsg: string
-      errorCode: string | number
+      errorMsg: string;
+      errorCode: string | number;
       innerError?: {
-        errorCode: string | number
-        errorMsg: string
-      }
-    }) => void
-    complete?: () => void
-  }): void
+        errorCode: string | number;
+        errorMsg: string;
+      };
+    }) => void;
+    complete?: () => void;
+  }): void;
 }
 
 declare namespace WechatMiniprogram {
   interface Wx {
-    requestCloud(params: RequestCloudParams): RequestCloudReturn
+    requestCloud(params: RequestCloudParams): RequestCloudReturn;
   }
 }

package/lib/DeviceKit-4.13.1.d.ts

@@ -1145,7 +1145,8 @@ export declare const validDeviceOnlineType: typeof ty.device.validDeviceOnlineTy
 export declare const publishDpsBase: typeof ty.device.publishDps;
 /**
  * @public
- * @since @ray-js/ray 0.10.4
+ * @since @ray-js/ray 1.7.68
+ * @remarks 如 @ray-js/ray < 1.7.68，可使用别名 `publishDpsBase`，用法一致
  * @example 基础调用
  * ```tsx
  * import { device } from '@ray-js/ray';

package/lib/DeviceKit-4.13.1.js

@@ -1257,7 +1257,8 @@ export const publishDpsBase = factory('publishDps', {
 });
 /**
  * @public
- * @since @ray-js/ray 0.10.4
+ * @since @ray-js/ray 1.7.68
+ * @remarks 如 @ray-js/ray < 1.7.68，可使用别名 `publishDpsBase`，用法一致
  * @example 基础调用
  * ```tsx
  * import { device } from '@ray-js/ray';

package/lib/WearKit-3.1.0.d.ts

@@ -1,4 +1,10 @@
 /// <reference path="../@types/WearKit.d.ts" />
+/**
+ * @public
+ * @since @ray-js/ray 1.7.14
+ * @deprecated @ray-js/ray 1.7.82起废弃，改用 startAudioRecording
+ */
+export declare const startRecordTransfer: typeof ty.wear.startRecordTransfer;
 /**
  * @public
  * @since @ray-js/ray 1.7.14

package/lib/WearKit-3.1.0.js

@@ -2,6 +2,16 @@
 
 import { createFactory } from './utils';
 const factory = createFactory('WearKit');
+
+/**
+ * @public
+ * @since @ray-js/ray 1.7.14
+ * @deprecated @ray-js/ray 1.7.82起废弃，改用 startAudioRecording
+ */
+export const startRecordTransfer = factory('startRecordTransfer', {
+  namespace: 'wear'
+});
+
 /**
  * @public
  * @since @ray-js/ray 1.7.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.7.82",
+  "version": "1.7.83",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,8 +29,8 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.7.82",
-    "@ray-js/router": "1.7.82",
+    "@ray-js/framework": "1.7.83",
+    "@ray-js/router": "1.7.83",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
@@ -38,7 +38,7 @@
     "@ray-js/wechat": "^0.3.13"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.7.82",
+    "@ray-js/cli": "1.7.83",
     "art-template": "^4.13.4",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.3",
@@ -48,5 +48,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "gitHead": "195284fb0c06336d906ba8ccf81fb3b21fca6318"
+  "gitHead": "f431d6e9c446b1f0668fcb11f04c5df98a3c0ac2"
 }