mirror of
https://github.com/mii443/vrclipboard-ime-gui.git
synced 2025-08-22 16:15:32 +00:00
209 lines
6.3 KiB
JavaScript
209 lines
6.3 KiB
JavaScript
'use strict';
|
|
|
|
// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
function mockInternals() {
|
|
var _a;
|
|
window.__TAURI_INTERNALS__ = (_a = window.__TAURI_INTERNALS__) !== null && _a !== void 0 ? _a : {};
|
|
}
|
|
/**
|
|
* Intercepts all IPC requests with the given mock handler.
|
|
*
|
|
* This function can be used when testing tauri frontend applications or when running the frontend in a Node.js context during static site generation.
|
|
*
|
|
* # Examples
|
|
*
|
|
* Testing setup using Vitest:
|
|
* ```js
|
|
* import { mockIPC, clearMocks } from "@tauri-apps/api/mocks"
|
|
* import { invoke } from "@tauri-apps/api/core"
|
|
*
|
|
* afterEach(() => {
|
|
* clearMocks()
|
|
* })
|
|
*
|
|
* test("mocked command", () => {
|
|
* mockIPC((cmd, payload) => {
|
|
* switch (cmd) {
|
|
* case "add":
|
|
* return (payload.a as number) + (payload.b as number);
|
|
* default:
|
|
* break;
|
|
* }
|
|
* });
|
|
*
|
|
* expect(invoke('add', { a: 12, b: 15 })).resolves.toBe(27);
|
|
* })
|
|
* ```
|
|
*
|
|
* The callback function can also return a Promise:
|
|
* ```js
|
|
* import { mockIPC, clearMocks } from "@tauri-apps/api/mocks"
|
|
* import { invoke } from "@tauri-apps/api/core"
|
|
*
|
|
* afterEach(() => {
|
|
* clearMocks()
|
|
* })
|
|
*
|
|
* test("mocked command", () => {
|
|
* mockIPC((cmd, payload) => {
|
|
* if(cmd === "get_data") {
|
|
* return fetch("https://example.com/data.json")
|
|
* .then((response) => response.json())
|
|
* }
|
|
* });
|
|
*
|
|
* expect(invoke('get_data')).resolves.toBe({ foo: 'bar' });
|
|
* })
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
function mockIPC(cb) {
|
|
mockInternals();
|
|
window.__TAURI_INTERNALS__.transformCallback = function transformCallback(
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
callback, once = false) {
|
|
const identifier = window.crypto.getRandomValues(new Uint32Array(1))[0];
|
|
const prop = `_${identifier}`;
|
|
Object.defineProperty(window, prop, {
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
value: (result) => {
|
|
if (once) {
|
|
Reflect.deleteProperty(window, prop);
|
|
}
|
|
return callback && callback(result);
|
|
},
|
|
writable: false,
|
|
configurable: true
|
|
});
|
|
return identifier;
|
|
};
|
|
// eslint-disable-next-line @typescript-eslint/require-await
|
|
window.__TAURI_INTERNALS__.invoke = async function (cmd, args,
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
options) {
|
|
return cb(cmd, args);
|
|
};
|
|
}
|
|
/**
|
|
* Mocks one or many window labels.
|
|
* In non-tauri context it is required to call this function *before* using the `@tauri-apps/api/window` module.
|
|
*
|
|
* This function only mocks the *presence* of windows,
|
|
* window properties (e.g. width and height) can be mocked like regular IPC calls using the `mockIPC` function.
|
|
*
|
|
* # Examples
|
|
*
|
|
* ```js
|
|
* import { mockWindows } from "@tauri-apps/api/mocks";
|
|
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
|
*
|
|
* mockWindows("main", "second", "third");
|
|
*
|
|
* const win = getCurrentWindow();
|
|
*
|
|
* win.label // "main"
|
|
* ```
|
|
*
|
|
* ```js
|
|
* import { mockWindows } from "@tauri-apps/api/mocks";
|
|
*
|
|
* mockWindows("main", "second", "third");
|
|
*
|
|
* mockIPC((cmd, args) => {
|
|
* if (cmd === "plugin:event|emit") {
|
|
* console.log('emit event', args?.event, args?.payload);
|
|
* }
|
|
* });
|
|
*
|
|
* const { emit } = await import("@tauri-apps/api/event");
|
|
* await emit('loaded'); // this will cause the mocked IPC handler to log to the console.
|
|
* ```
|
|
*
|
|
* @param current Label of window this JavaScript context is running in.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
function mockWindows(current, ..._additionalWindows) {
|
|
mockInternals();
|
|
window.__TAURI_INTERNALS__.metadata = {
|
|
currentWindow: { label: current },
|
|
currentWebview: { windowLabel: current, label: current }
|
|
};
|
|
}
|
|
/**
|
|
* Mock `convertFileSrc` function
|
|
*
|
|
*
|
|
* @example
|
|
* ```js
|
|
* import { mockConvertFileSrc } from "@tauri-apps/api/mocks";
|
|
* import { convertFileSrc } from "@tauri-apps/api/core";
|
|
*
|
|
* mockConvertFileSrc("windows")
|
|
*
|
|
* const url = convertFileSrc("C:\\Users\\user\\file.txt")
|
|
* ```
|
|
*
|
|
* @param osName The operating system to mock, can be one of linux, macos, or windows
|
|
*
|
|
* @since 1.6.0
|
|
*/
|
|
function mockConvertFileSrc(osName) {
|
|
mockInternals();
|
|
window.__TAURI_INTERNALS__.convertFileSrc = function (filePath, protocol = 'asset') {
|
|
const path = encodeURIComponent(filePath);
|
|
return osName === 'windows'
|
|
? `http://${protocol}.localhost/${path}`
|
|
: `${protocol}://localhost/${path}`;
|
|
};
|
|
}
|
|
/**
|
|
* Clears mocked functions/data injected by the other functions in this module.
|
|
* When using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```js
|
|
* import { mockWindows, clearMocks } from "@tauri-apps/api/mocks"
|
|
*
|
|
* afterEach(() => {
|
|
* clearMocks()
|
|
* })
|
|
*
|
|
* test("mocked windows", () => {
|
|
* mockWindows("main", "second", "third");
|
|
*
|
|
* expect(window.__TAURI_INTERNALS__).toHaveProperty("metadata")
|
|
* })
|
|
*
|
|
* test("no mocked windows", () => {
|
|
* expect(window.__TAURI_INTERNALS__).not.toHaveProperty("metadata")
|
|
* })
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
function clearMocks() {
|
|
var _a, _b, _c;
|
|
if (typeof window.__TAURI_INTERNALS__ !== 'object') {
|
|
return;
|
|
}
|
|
if ((_a = window.__TAURI_INTERNALS__) === null || _a === void 0 ? void 0 : _a.convertFileSrc)
|
|
// @ts-expect-error "The operand of a 'delete' operator must be optional' does not matter in this case
|
|
delete window.__TAURI_INTERNALS__.convertFileSrc;
|
|
if ((_b = window.__TAURI_INTERNALS__) === null || _b === void 0 ? void 0 : _b.invoke)
|
|
// @ts-expect-error "The operand of a 'delete' operator must be optional' does not matter in this case
|
|
delete window.__TAURI_INTERNALS__.invoke;
|
|
if ((_c = window.__TAURI_INTERNALS__) === null || _c === void 0 ? void 0 : _c.metadata)
|
|
// @ts-expect-error "The operand of a 'delete' operator must be optional' does not matter in this case
|
|
delete window.__TAURI_INTERNALS__.metadata;
|
|
}
|
|
|
|
exports.clearMocks = clearMocks;
|
|
exports.mockConvertFileSrc = mockConvertFileSrc;
|
|
exports.mockIPC = mockIPC;
|
|
exports.mockWindows = mockWindows;
|