@quicktvui/ai 1.0.6 → 1.0.7

package/rules/.source/ESVue/src/runtime/websocket/websocket.ts

@@ -0,0 +1,282 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { isFunction } from "@vue/shared";
+import type { NeedToTyped, CallbackType } from "../../types";
+
+import { warn, getNormalizeEventName } from "../../util";
+import { EventBus } from "../event/event-bus";
+import { Native } from "../native";
+
+interface EventListeners {
+  [eventName: string]: CallbackType[];
+}
+
+/**
+ * type of websocket callback
+ *
+ * @public
+ */
+export interface WebsocketCallback {
+  onOpen?: CallbackType[];
+  onClose?: CallbackType[];
+  onError?: CallbackType[];
+  onMessage?: CallbackType[];
+}
+
+// websocket state constants
+const READY_STATE_CONNECTING = 0;
+const READY_STATE_OPEN = 1;
+const READY_STATE_CLOSING = 2;
+const READY_STATE_CLOSED = 3;
+
+// module name of websocket
+const WEB_SOCKET_MODULE_NAME = "websocket";
+// native event name for websocket
+const WEB_SOCKET_NATIVE_EVENT = "hippyWebsocketEvents";
+
+/**
+ * determine whether it is a legitimate websocket event
+ *
+ * @param type - event type
+ */
+const isValidEventType = (type: string): boolean =>
+  ["open", "close", "message", "error"].indexOf(type) !== -1;
+
+/**
+ * The WebSocket API is an advanced technology that makes it possible to open a two-way
+ * interactive communication session between the user's browser and a server. With this API,
+ * you can send messages to a server and receive event-driven responses without having to
+ * poll the server for a reply.
+ */
+class WebSocket {
+  // status code of websocket
+  public readyState: number;
+
+  // callback of websocket
+  public webSocketCallbacks: WebsocketCallback;
+
+  // webSocketId
+  public webSocketId = -1;
+
+  // websocket link to access
+  public readonly url: string;
+
+  // the protocol chosen by the server
+  public readonly protocol: string = "";
+
+  // event listeners
+  protected listeners: EventListeners = {};
+
+  /**
+   * Returns a newly created WebSocket object.
+   *
+   * @param url - The URL to which to connect; this should be the URL to which the
+   *                       WebSocket server will respond.
+   * @param protocols - Either a single protocol string or an array
+   *                                          of protocol strings. These strings are used to
+   *                                          indicate sub-protocols, so that a single server
+   *                                          can implement multiple WebSocket sub-protocols
+   *                                          (for example, you might want one server to be able
+   *                                          to handle different types of interactions depending
+   *                                          on the specified protocol).
+   *                                          If you don't specify a protocol string, an empty
+   *                                          string is assumed.
+   * @param extrasHeaders - Http headers will append to connection.
+   */
+  constructor(
+    url: string,
+    protocols?: string | string[],
+    extrasHeaders?: { [key: string]: NeedToTyped },
+  ) {
+    this.url = url;
+    this.readyState = READY_STATE_CONNECTING;
+    this.webSocketCallbacks = {};
+    this.onWebSocketEvent = this.onWebSocketEvent.bind(this);
+    const headers = {
+      ...extrasHeaders,
+    };
+
+    EventBus.$on(WEB_SOCKET_NATIVE_EVENT, this.onWebSocketEvent);
+
+    if (!url) {
+      throw new TypeError("Invalid WebSocket url");
+    }
+
+    if (Array.isArray(protocols) && protocols.length > 0) {
+      this.protocol = protocols.join(",");
+      headers["Sec-WebSocket-Protocol"] = this.protocol;
+    } else if (typeof protocols === "string") {
+      this.protocol = protocols;
+      headers["Sec-WebSocket-Protocol"] = this.protocol;
+    }
+
+    const params = {
+      headers,
+      url,
+    };
+
+    Native.callNativeWithPromise(
+      WEB_SOCKET_MODULE_NAME,
+      "connect",
+      params,
+    ).then((resp) => {
+      if (!resp || resp.code !== 0) {
+        warn("Fail to create websocket connection", resp);
+        return;
+      }
+
+      this.webSocketId = resp.id;
+    });
+  }
+
+  /**
+   * Closes the WebSocket connection or connection attempt, if any.
+   * If the connection is already CLOSED, this method does nothing.
+   *
+   * @param code - A numeric value indicating the status code explaining
+   *                          why the connection is being closed. If this parameter
+   *                          is not specified, a default value of 1005 is assumed.
+   *                          See the list of status codes of CloseEvent for permitted values.
+   * @param reason - A human-readable string explaining why the connection
+   *                            is closing. This string must be no longer than 123 bytes
+   *                            of UTF-8 text (not characters).
+   */
+  close(code, reason): void {
+    if (this.readyState !== READY_STATE_OPEN) {
+      return;
+    }
+
+    this.readyState = READY_STATE_CLOSING;
+    Native.callNative(WEB_SOCKET_MODULE_NAME, "close", {
+      id: this.webSocketId,
+      code,
+      reason,
+    });
+  }
+
+  /**
+   * Enqueues the specified data to be transmitted to the server over the WebSocket connection.
+   *
+   * @param data - The data to send to the server. Hippy supports string type only.
+   */
+  send(data): void {
+    if (this.readyState !== READY_STATE_OPEN) {
+      warn("WebSocket is not connected");
+      return;
+    }
+
+    if (typeof data !== "string") {
+      throw new TypeError(`Unsupported websocket data type: ${typeof data}`);
+    }
+
+    Native.callNative(WEB_SOCKET_MODULE_NAME, "send", {
+      id: this.webSocketId,
+      data,
+    });
+  }
+
+  /**
+   * Set an EventHandler that is called when the WebSocket connection's readyState changes to OPEN;
+   */
+  set onopen(callback) {
+    this.addEventListener("open", callback);
+  }
+
+  /**
+   * Set an EventHandler that is called when the WebSocket connection's readyState
+   * changes to CLOSED.
+   */
+  set onclose(callback) {
+    this.addEventListener("close", callback);
+  }
+
+  /**
+   * Set an EventHandler that is called when a message is received from the server.
+   */
+  set onerror(callback) {
+    this.addEventListener("error", callback);
+  }
+
+  /**
+   * Set an event handler property is a function which gets called when an error
+   * occurs on the WebSocket.
+   */
+  set onmessage(callback) {
+    this.addEventListener("message", callback);
+  }
+
+  /**
+   * WebSocket events handler from Native.
+   *
+   * @param param - Native response.
+   */
+  onWebSocketEvent(param): void {
+    if (typeof param !== "object" || param.id !== this.webSocketId) {
+      return;
+    }
+
+    const eventType = param.type;
+    if (typeof eventType !== "string") {
+      return;
+    }
+
+    if (eventType === "onOpen") {
+      this.readyState = READY_STATE_OPEN;
+    } else if (eventType === "onClose") {
+      this.readyState = READY_STATE_CLOSED;
+      EventBus.$off(WEB_SOCKET_NATIVE_EVENT, this.onWebSocketEvent);
+    }
+
+    const callbacks = this.webSocketCallbacks[eventType];
+    if (callbacks?.length) {
+      callbacks.forEach((callback) => {
+        if (isFunction(callback)) {
+          callback(param.data);
+        }
+      });
+    }
+  }
+
+  /**
+   * Add websocket event listener
+   *
+   * @param type - event type
+   * @param listener - callback method
+   */
+  addEventListener(type: string, listener: CallbackType): void {
+    if (isValidEventType(type)) {
+      // If the event list of the listening type is not initialized, initialize it first
+      if (!this.listeners[type]) {
+        this.listeners[type] = [];
+      }
+
+      // add event listeners
+      this.listeners[type].push(listener);
+
+      const typeName = getNormalizeEventName(type);
+      this.webSocketCallbacks[typeName] = this.listeners[type];
+    }
+  }
+}
+
+// assign websocket to global
+// @ts-ignore
+global.WebSocket = WebSocket;

package/rules/.source/ESVue/src/types/index.ts

@@ -0,0 +1,25 @@
+/**
+ * @public
+ */
+type NeedToTyped = any;
+
+/**
+ * @public
+ */
+type CallbackType = Function;
+
+/**
+ * @public
+ */
+interface CommonMapParams {
+  [key: string]: NeedToTyped;
+}
+
+// global type
+export { NeedToTyped, CallbackType, CommonMapParams };
+
+// native node type
+export { NativeNode, NativeNodeProps } from "./native-node";
+
+// native interface map type
+export { NativeInterfaceMap } from "./native-modules";

package/rules/.source/ESVue/src/types/native-modules/clip-board-module.ts

@@ -0,0 +1,24 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface ClipboardModule {
+  getString: () => string;
+  setString: (content: string) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/device-event-module.ts

@@ -0,0 +1,24 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface DeviceEventModule {
+  invokeDefaultBackPressHandler: () => void;
+  setListenBackPress: (flag: boolean) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/http.ts

@@ -0,0 +1,57 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { NeedToTyped } from "../index";
+
+export interface HttpRequestParams {
+  method: string;
+  data?: Record<string, NeedToTyped>;
+  headers: Record<string, string>;
+  url: string;
+}
+
+export interface NativeRequestBaseResponse {
+  success: boolean;
+  code: number;
+}
+
+export interface NativeRequestSuccess extends NativeRequestBaseResponse {
+  type: "SUCCESS";
+  data: {
+    code: number;
+    result: {
+      code: number;
+      data: NeedToTyped;
+    }[];
+  };
+}
+
+export interface NativeRequestError extends NativeRequestBaseResponse {
+  type: "ERROR";
+  errorText: string;
+}
+
+export type NativeRequestResponse = NativeRequestSuccess | NativeRequestError;
+
+export interface Http {
+  request: (
+    params: HttpRequestParams,
+    callback: (res: NativeRequestResponse) => void,
+  ) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/image-loader-module.ts

@@ -0,0 +1,27 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface ImageLoaderModule {
+  getSize: (url: string) => {
+    width: number;
+    height: number;
+  };
+  prefetch: (url: string) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/net-info.ts

@@ -0,0 +1,29 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface NetStatus {
+  network_info: string;
+}
+
+export interface NetInfo {
+  getCurrentConnectivity: () => NetStatus;
+  addListener: (eventName: string) => void;
+  removeListener: (eventName: string) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/network.ts

@@ -0,0 +1,24 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Network {
+  getCookie: (url: string) => string;
+  setCookie: (url: string, keyValue: string, expireStr: string) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/test-module.ts

@@ -0,0 +1,23 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface TestModule {
+  remoteDebug: (rootViewId: number, bundleUrl: string) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/ui-manager-module.ts

@@ -0,0 +1,44 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { CallbackType, NeedToTyped } from "../index";
+
+// The parameter lists of android and ios are inconsistent
+type CallUIFunctionArgs =
+  | [nodeId: number, funcName: string, args: NeedToTyped]
+  | [
+      componentName: string,
+      nodeId: number,
+      funcName: string,
+      args: NeedToTyped,
+    ];
+
+export interface UiManagerModule {
+  callUIFunction: (
+    args: CallUIFunctionArgs,
+    callback?: (...params: NeedToTyped[]) => NeedToTyped,
+  ) => void;
+  measureInWindow: (nodeId: number, callback: CallbackType) => void;
+  measureInAppWindow: (nodeId: number, callback: CallbackType) => void;
+  getBoundingClientRect: (
+    nodeId: number,
+    options: NeedToTyped,
+    callback: CallbackType,
+  ) => void;
+}

package/rules/.source/ESVue/src/types/native-modules/websocket.ts

@@ -0,0 +1,49 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { NeedToTyped } from "../index";
+
+export interface ConnectArgs {
+  headers: {
+    [x: string]: NeedToTyped;
+  };
+  url: string;
+}
+
+export interface ConnectResp {
+  id: number;
+  code: number;
+}
+
+export interface CloseArgs {
+  id: number;
+  reason: string;
+  code: number;
+}
+
+export interface SendArgs {
+  id: number;
+  data: string;
+}
+
+export interface Websocket {
+  connect: (args: ConnectArgs) => ConnectResp;
+  send: (args: SendArgs) => void;
+  close: (args: CloseArgs) => void;
+}

package/rules/.source/ESVue/src/types/native-modules.ts

@@ -0,0 +1,41 @@
+/*
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ClipboardModule } from "./native-modules/clip-board-module";
+import type { DeviceEventModule } from "./native-modules/device-event-module";
+import type { Http } from "./native-modules/http";
+import type { ImageLoaderModule } from "./native-modules/image-loader-module";
+import type { NetInfo } from "./native-modules/net-info";
+import type { Network } from "./native-modules/network";
+import type { TestModule } from "./native-modules/test-module";
+import type { UiManagerModule } from "./native-modules/ui-manager-module";
+import type { Websocket } from "./native-modules/websocket";
+
+export interface NativeInterfaceMap {
+  // The key here is the module name set by the native and cannot be changed at will.
+  UIManagerModule: UiManagerModule;
+  ImageLoaderModule: ImageLoaderModule;
+  websocket: Websocket;
+  NetInfo: NetInfo;
+  ClipboardModule: ClipboardModule;
+  network: Network;
+  DeviceEventModule: DeviceEventModule;
+  http: Http;
+  TestModule: TestModule;
+}