@ejazullah/browser-mcp 0.0.56

package/lib/tools/utils.js

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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.
+ */
+// @ts-ignore
+import { asLocator } from 'playwright-core/lib/utils';
+export async function waitForCompletion(tab, callback) {
+    const requests = new Set();
+    let frameNavigated = false;
+    let waitCallback = () => { };
+    const waitBarrier = new Promise(f => { waitCallback = f; });
+    const requestListener = (request) => requests.add(request);
+    const requestFinishedListener = (request) => {
+        requests.delete(request);
+        if (!requests.size)
+            waitCallback();
+    };
+    const frameNavigateListener = (frame) => {
+        if (frame.parentFrame())
+            return;
+        frameNavigated = true;
+        dispose();
+        clearTimeout(timeout);
+        void tab.waitForLoadState('load').then(waitCallback);
+    };
+    const onTimeout = () => {
+        dispose();
+        waitCallback();
+    };
+    tab.page.on('request', requestListener);
+    tab.page.on('requestfinished', requestFinishedListener);
+    tab.page.on('framenavigated', frameNavigateListener);
+    const timeout = setTimeout(onTimeout, 10000);
+    const dispose = () => {
+        tab.page.off('request', requestListener);
+        tab.page.off('requestfinished', requestFinishedListener);
+        tab.page.off('framenavigated', frameNavigateListener);
+        clearTimeout(timeout);
+    };
+    try {
+        const result = await callback();
+        if (!requests.size && !frameNavigated)
+            waitCallback();
+        await waitBarrier;
+        await tab.waitForTimeout(1000);
+        return result;
+    }
+    finally {
+        dispose();
+    }
+}
+export async function generateLocator(locator) {
+    try {
+        const { resolvedSelector } = await locator._resolveSelector();
+        return asLocator('javascript', resolvedSelector);
+    }
+    catch (e) {
+        throw new Error('Ref not found, likely because element was removed. Use browser_snapshot to see what elements are currently on the page.');
+    }
+}
+export async function callOnPageNoTrace(page, callback) {
+    return await page._wrapApiCall(() => callback(page), { internal: true });
+}

package/lib/tools/wait.js

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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 { z } from 'zod';
+import { defineTool } from './tool.js';
+const wait = defineTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_wait_for',
+        title: 'Wait for',
+        description: 'Wait for text to appear or disappear or a specified time to pass',
+        inputSchema: z.object({
+            time: z.number().optional().describe('The time to wait in seconds'),
+            text: z.string().optional().describe('The text to wait for'),
+            textGone: z.string().optional().describe('The text to wait for to disappear'),
+        }),
+        type: 'readOnly',
+    },
+    handle: async (context, params, response) => {
+        if (!params.text && !params.textGone && !params.time)
+            throw new Error('Either time, text or textGone must be provided');
+        const code = [];
+        if (params.time) {
+            code.push(`await new Promise(f => setTimeout(f, ${params.time} * 1000));`);
+            await new Promise(f => setTimeout(f, Math.min(30000, params.time * 1000)));
+        }
+        const tab = context.currentTabOrDie();
+        const locator = params.text ? tab.page.getByText(params.text).first() : undefined;
+        const goneLocator = params.textGone ? tab.page.getByText(params.textGone).first() : undefined;
+        if (goneLocator) {
+            code.push(`await page.getByText(${JSON.stringify(params.textGone)}).first().waitFor({ state: 'hidden' });`);
+            await goneLocator.waitFor({ state: 'hidden' });
+        }
+        if (locator) {
+            code.push(`await page.getByText(${JSON.stringify(params.text)}).first().waitFor({ state: 'visible' });`);
+            await locator.waitFor({ state: 'visible' });
+        }
+        response.addResult(`Waited for ${params.text || params.textGone || params.time}`);
+        response.setIncludeSnapshot();
+    },
+});
+export default [
+    wait,
+];

package/lib/tools.js

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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 common from './tools/common.js';
+import console from './tools/console.js';
+import dialogs from './tools/dialogs.js';
+import evaluate from './tools/evaluate.js';
+import extraction from './tools/extraction.js';
+import files from './tools/files.js';
+import forms from './tools/forms.js';
+import getext from './tools/getext.js';
+import install from './tools/install.js';
+import interactions from './tools/interactions.js';
+import keyboard from './tools/keyboard.js';
+import navigate from './tools/navigate.js';
+import network from './tools/network.js';
+import pdf from './tools/pdf.js';
+import selectors from './tools/selectors.js';
+import snapshot from './tools/snapshot.js';
+import states from './tools/states.js';
+import tabs from './tools/tabs.js';
+import screenshot from './tools/screenshot.js';
+import wait from './tools/wait.js';
+import mouse from './tools/mouse.js';
+import { cdpTools } from './tools/cdp.js';
+export const allTools = [
+    ...cdpTools,
+    ...common,
+    ...console,
+    ...dialogs,
+    ...evaluate,
+    ...extraction,
+    ...files,
+    ...forms,
+    ...getext,
+    ...install,
+    ...interactions,
+    ...keyboard,
+    ...navigate,
+    ...network,
+    ...mouse,
+    ...pdf,
+    ...screenshot,
+    ...selectors,
+    ...snapshot,
+    ...states,
+    ...tabs,
+    ...wait,
+];
+export function filteredTools(config) {
+    return allTools.filter(tool => tool.capability.startsWith('core') || config.capabilities?.includes(tool.capability));
+}

package/lib/utils.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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 crypto from 'crypto';
+export function createHash(data) {
+    return crypto.createHash('sha256').update(data).digest('hex').slice(0, 7);
+}
+export function sanitizeForFilePath(s) {
+    const sanitize = (s) => s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-');
+    const separator = s.lastIndexOf('.');
+    if (separator === -1)
+        return sanitize(s);
+    return sanitize(s.substring(0, separator)) + '.' + sanitize(s.substring(separator + 1));
+}