webdriver-bidi-protocol 0.2.11 → 0.3.1

package/src/index.ts

@@ -12,12 +12,21 @@ export * from './gen/main.js';
 export * from './gen/permissions.js';
 export * from './gen/web-bluetooth.js';
 
+export type {CommandMapping} from './gen/mapping.d.ts';
+
 type ExternalSpecCommand<T> = {
   // id is defined by the main WebDriver BiDi spec and extension specs do
   // not re-define it. Therefore, it's not part of generated types.
   id: Bidi.JsUint;
 } & T;
 
+export type Result = Bidi.ResultData;
+
+export type Command =
+  | Bidi.Command
+  | ExternalSpecCommand<BidiPermissions.PermissionsCommand>
+  | ExternalSpecCommand<BidiBluetooth.BluetoothCommand>;
+
 type ExternalSpecEvent<T> = {
   // type is defined by the main WebDriver BiDi spec and extension specs do
   // not re-define it. Therefore, it's not part of generated types.
@@ -25,279 +34,6 @@ type ExternalSpecEvent<T> = {
 } & T &
   Bidi.Extensible;
 
-export type Command =
-  | Bidi.Command
-  | ExternalSpecCommand<BidiPermissions.PermissionsCommand>
-  | ExternalSpecCommand<BidiBluetooth.BluetoothCommand>;
-
 export type Event =
   | Bidi.Event
   | ExternalSpecEvent<BidiBluetooth.BluetoothEvent>;
-
-// TODO: is there a way to generate this mapping?
-export interface Commands {
-  'bluetooth.handleRequestDevicePrompt': {
-    params: BidiBluetooth.Bluetooth.HandleRequestDevicePromptParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.disableSimulation': {
-    params: BidiBluetooth.Bluetooth.DisableSimulationParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.simulateAdapter': {
-    params: BidiBluetooth.Bluetooth.SimulateAdapterParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.simulateAdvertisement': {
-    params: BidiBluetooth.Bluetooth.SimulateAdvertisementParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.simulatePreconnectedPeripheral': {
-    params: BidiBluetooth.Bluetooth.SimulatePreconnectedPeripheralParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.simulateGattDisconnection': {
-    params: BidiBluetooth.Bluetooth.SimulateGattDisconnectionParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.simulateDescriptor': {
-    params: BidiBluetooth.Bluetooth.SimulateDescriptorParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'bluetooth.simulateDescriptorResponse': {
-    params: BidiBluetooth.Bluetooth.SimulateDescriptorResponseParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'browser.close': {
-    params: Bidi.EmptyParams;
-    returnType: Bidi.EmptyResult;
-  };
-  'browser.getgetClientWindows': {
-    params: Bidi.EmptyParams;
-    returnType: Bidi.Browser.GetClientWindowsResult;
-  };
-  'browser.createUserContext': {
-    params: Bidi.EmptyParams;
-    returnType: Bidi.Browser.CreateUserContextResult;
-  };
-  'browser.getUserContexts': {
-    params: Bidi.EmptyParams;
-    returnType: Bidi.Browser.GetUserContextsResult;
-  };
-  'browser.removeUserContext': {
-    params: {
-      userContext: Bidi.Browser.UserContext;
-    };
-    returnType: Bidi.Browser.RemoveUserContext;
-  };
-  'browser.setClientWindowState': {
-    params: Bidi.Browser.SetClientWindowStateParameters;
-    returnType: Bidi.Browser.ClientWindowInfo;
-  };
-
-  'browsingContext.activate': {
-    params: Bidi.BrowsingContext.ActivateParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'browsingContext.create': {
-    params: Bidi.BrowsingContext.CreateParameters;
-    returnType: Bidi.BrowsingContext.CreateResult;
-  };
-  'browsingContext.close': {
-    params: Bidi.BrowsingContext.CloseParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'browsingContext.getTree': {
-    params: Bidi.BrowsingContext.GetTreeParameters;
-    returnType: Bidi.BrowsingContext.GetTreeResult;
-  };
-  'browsingContext.locateNodes': {
-    params: Bidi.BrowsingContext.LocateNodesParameters;
-    returnType: Bidi.BrowsingContext.LocateNodesResult;
-  };
-  'browsingContext.navigate': {
-    params: Bidi.BrowsingContext.NavigateParameters;
-    returnType: Bidi.BrowsingContext.NavigateResult;
-  };
-  'browsingContext.reload': {
-    params: Bidi.BrowsingContext.ReloadParameters;
-    returnType: Bidi.BrowsingContext.NavigateResult;
-  };
-  'browsingContext.print': {
-    params: Bidi.BrowsingContext.PrintParameters;
-    returnType: Bidi.BrowsingContext.PrintResult;
-  };
-  'browsingContext.captureScreenshot': {
-    params: Bidi.BrowsingContext.CaptureScreenshotParameters;
-    returnType: Bidi.BrowsingContext.CaptureScreenshotResult;
-  };
-  'browsingContext.handleUserPrompt': {
-    params: Bidi.BrowsingContext.HandleUserPromptParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'browsingContext.setViewport': {
-    params: Bidi.BrowsingContext.SetViewportParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'browsingContext.traverseHistory': {
-    params: Bidi.BrowsingContext.TraverseHistoryParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'emulation.setForcedColorsModeThemeOverride': {
-    params: Bidi.Emulation.SetForcedColorsModeThemeOverrideParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'emulation.setGeolocationOverride': {
-    params: Bidi.Emulation.SetGeolocationOverrideParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'emulation.setLocaleOverride': {
-    params: Bidi.Emulation.SetLocaleOverrideParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'emulation.setScreenOrientationOverride': {
-    params: Bidi.Emulation.SetScreenOrientationOverrideParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'emulation.setTimezoneOverride': {
-    params: Bidi.Emulation.SetTimezoneOverrideParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'emulation.setScriptingEnabled': {
-    params: Bidi.Emulation.SetScriptingEnabledParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'emulation.setUserAgentOverride': {
-    params: Bidi.Emulation.SetUserAgentOverrideParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'input.performActions': {
-    params: Bidi.Input.PerformActionsParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'input.releaseActions': {
-    params: Bidi.Input.ReleaseActionsParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'input.setFiles': {
-    params: Bidi.Input.SetFilesParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'permissions.setPermission': {
-    params: BidiPermissions.Permissions.SetPermissionParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'script.evaluate': {
-    params: Bidi.Script.EvaluateParameters;
-    returnType: Bidi.Script.EvaluateResult;
-  };
-  'script.callFunction': {
-    params: Bidi.Script.CallFunctionParameters;
-    returnType: Bidi.Script.EvaluateResult;
-  };
-  'script.disown': {
-    params: Bidi.Script.DisownParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'script.addPreloadScript': {
-    params: Bidi.Script.AddPreloadScriptParameters;
-    returnType: Bidi.Script.AddPreloadScriptResult;
-  };
-  'script.removePreloadScript': {
-    params: Bidi.Script.RemovePreloadScriptParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'session.end': {
-    params: Bidi.EmptyParams;
-    returnType: Bidi.EmptyResult;
-  };
-  'session.new': {
-    params: Bidi.Session.NewParameters;
-    returnType: Bidi.Session.NewResult;
-  };
-  'session.status': {
-    params: object;
-    returnType: Bidi.Session.StatusResult;
-  };
-  'session.subscribe': {
-    params: Bidi.Session.SubscriptionRequest;
-    returnType: Bidi.EmptyResult;
-  };
-  'session.unsubscribe': {
-    params: Bidi.Session.SubscriptionRequest;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'storage.deleteCookies': {
-    params: Bidi.Storage.DeleteCookiesParameters;
-    returnType: Bidi.Storage.DeleteCookiesResult;
-  };
-  'storage.getCookies': {
-    params: Bidi.Storage.GetCookiesParameters;
-    returnType: Bidi.Storage.GetCookiesResult;
-  };
-  'storage.setCookie': {
-    params: Bidi.Storage.SetCookieParameters;
-    returnType: Bidi.Storage.SetCookieParameters;
-  };
-
-  'network.addDataCollector': {
-    params: Bidi.Network.AddDataCollectorParameters;
-    returnType: Bidi.Network.AddDataCollectorResult;
-  };
-  'network.addIntercept': {
-    params: Bidi.Network.AddInterceptParameters;
-    returnType: Bidi.Network.AddInterceptResult;
-  };
-  'network.removeIntercept': {
-    params: Bidi.Network.RemoveInterceptParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.continueRequest': {
-    params: Bidi.Network.ContinueRequestParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.continueWithAuth': {
-    params: Bidi.Network.ContinueWithAuthParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.failRequest': {
-    params: Bidi.Network.FailRequestParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.provideResponse': {
-    params: Bidi.Network.ProvideResponseParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.disownData': {
-    params: Bidi.Network.DisownDataParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.getData': {
-    params: Bidi.Network.GetDataParameters;
-    returnType: Bidi.Network.GetDataResult;
-  };
-  'network.setCacheBehavior': {
-    params: Bidi.Network.SetCacheBehaviorParameters;
-    returnType: Bidi.EmptyResult;
-  };
-  'network.setExtraHeaders': {
-    params: Bidi.Network.SetExtraHeadersParameters;
-    returnType: Bidi.EmptyResult;
-  };
-
-  'webExtension.install': {
-    params: Bidi.WebExtension.InstallParameters;
-    returnType: Bidi.WebExtension.InstallResult;
-  };
-  'webExtension.uninstall': {
-    params: Bidi.WebExtension.UninstallParameters;
-    returnType: Bidi.EmptyResult;
-  };
-}

package/test-d/webdriver-bidi-protocol.test-d.ts

@@ -4,14 +4,14 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {Event, Command, Commands} from '..';
+import {Event, Command, CommandMapping} from '..';
 
 function sendCommand(command: Command) {}
 function handleEvent(event: Event) {}
-function sendCommandMultipleArgs<T extends keyof Commands>(
+function sendCommandMultipleArgs<T extends keyof CommandMapping>(
   method: T,
-  params: Commands[T]['params'],
-): {result: Commands[T]['returnType']} {
+  params: CommandMapping[T]['params'],
+): {result: CommandMapping[T]['returnType']} {
   throw new Error('Not implemented');
 }
 

package/tools/build.sh

@@ -4,6 +4,8 @@
 # Copyright 2024 Google Inc.
 # SPDX-License-Identifier: Apache-2.0
 
+set -e
+
 rm -rf src/gen && mkdir src/gen
 rm -rf out
 
@@ -23,6 +25,7 @@ cddlconv specs/web-bluetooth/all.cddl > src/gen/web-bluetooth.ts
 
 git submodule deinit --all
 
+node ./tools/generateCommandMap.ts
 npx tsc -p tsconfig.json
 npx tsd
-npm run format
+npm run format

package/tools/generateCommandMap.ts

@@ -0,0 +1,162 @@
+/**
+ * @license
+ * Copyright 2025 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {Project, Type, TypeFormatFlags} from 'ts-morph';
+import * as path from 'path';
+import {
+  getResultNameFromMethod,
+  getTypeInNamespaceOrThrow,
+  type MappingInterface,
+  type SpecType,
+} from './utils.ts';
+
+const rootDir = path.resolve(import.meta.dirname, '..');
+
+const MAIN_SPEC_PREFIX = 'Bidi';
+
+const specs: SpecType[] = [
+  {
+    inputFile: './main.ts',
+    commandType: 'CommandData',
+    modulePrefix: MAIN_SPEC_PREFIX,
+  },
+  {
+    inputFile: './permissions.ts',
+    commandType: 'PermissionsCommand',
+    modulePrefix: 'BidiPermissions',
+  },
+  {
+    inputFile: './web-bluetooth.ts',
+    commandType: 'BluetoothCommand',
+    modulePrefix: 'BidiBluetooth',
+  },
+];
+
+const project = new Project({
+  tsConfigFilePath: path.resolve(rootDir, 'tsconfig.json'),
+});
+const commandMappingEntries: MappingInterface[] = [];
+for (const spec of specs) {
+  const apiIndexFile = project.addSourceFileAtPath(
+    path.resolve(rootDir, 'src/gen', spec.inputFile),
+  );
+
+  // Allow other name
+  const commandType = apiIndexFile.getTypeAliasOrThrow(spec.commandType);
+  const unionType = commandType.getType();
+  let types: Type[];
+  if (unionType.isUnion()) {
+    types = unionType.getUnionTypes();
+  } else {
+    types = [commandType.getTypeNodeOrThrow().getType()];
+  }
+
+  for (const unionMember of types) {
+    const methodProp = unionMember.getProperty('method');
+    if (!methodProp) {
+      // If not method is found continue.
+      // For some reason the Bluetooth spec has Record<string,never>
+      // TODO: fix it upstream
+      continue;
+    }
+
+    const methodType = methodProp.getTypeAtLocation(commandType);
+
+    if (!methodType.isStringLiteral()) {
+      throw new Error(`Non string found ${methodProp.getName()}`);
+    }
+
+    const methodString = `${methodType.getLiteralValue()}`;
+
+    const paramsProp = unionMember.getPropertyOrThrow('params');
+    const paramsType = paramsProp.getTypeAtLocation(commandType);
+
+    const paramsTypeString = paramsType.getText(
+      commandType,
+      TypeFormatFlags.None,
+    );
+
+    let prefix = spec.modulePrefix;
+    let expectedResultTypeName = paramsTypeString.replace(
+      'Parameters',
+      'Result',
+    );
+
+    // We need to infer from methods
+    // TODO: See if this is needed as a fallback always
+    if (paramsTypeString.includes('Extensible')) {
+      expectedResultTypeName = getResultNameFromMethod(methodString);
+    }
+
+    try {
+      // Usually we get something like `BrowsingContext.GetTreeResult`
+      getTypeInNamespaceOrThrow(apiIndexFile, expectedResultTypeName);
+    } catch {
+      try {
+        // Maybe it was not inside an Namespace try on the module scope
+        apiIndexFile.getTypeAliasOrThrow(expectedResultTypeName);
+      } catch {
+        // The EmptyResult is only available on the main spec
+        prefix = MAIN_SPEC_PREFIX;
+        // Default to EmptyResult
+        expectedResultTypeName = `EmptyResult`;
+      }
+    }
+
+    commandMappingEntries.push({
+      method: methodString,
+      params: `${spec.modulePrefix}.${paramsTypeString}`,
+      resultType: `${prefix}.${expectedResultTypeName}`,
+    });
+  }
+}
+
+// Start generating the mapping types
+const outputPath = path.resolve(rootDir, 'src/gen/mapping.ts');
+const generatedFile = project.createSourceFile(outputPath, '', {
+  overwrite: true,
+});
+
+for (const spec of specs) {
+  generatedFile.addImportDeclaration({
+    moduleSpecifier: spec.inputFile,
+    isTypeOnly: true,
+    namespaceImport: spec.modulePrefix,
+  });
+}
+
+const mapInterface = generatedFile.addInterface({
+  name: 'CommandMapping',
+  isExported: true,
+});
+
+const sortedCommandMappingEntries = commandMappingEntries.sort((a, b) => {
+  if (a.method > b.method) {
+    return 1;
+  } else if (a.method < b.method) {
+    return -1;
+  }
+
+  return 0;
+});
+
+for (const entry of sortedCommandMappingEntries) {
+  mapInterface.addProperty({
+    // Wrap in quotes as we use <module>.<command-name>
+    // syntax
+    name: `"${entry.method}"`,
+    type: writer => {
+      writer.write(`
+        {
+          params: ${entry.params};
+          returnType: ${entry.resultType};
+        }  
+        `);
+    },
+  });
+}
+
+await generatedFile.save();

package/tools/utils.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright 2025 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type {
+  ModuleDeclaration,
+  SourceFile,
+  TypeAliasDeclaration,
+} from 'ts-morph';
+
+export function getNamespaces(file: SourceFile, s: String) {
+  const result: ModuleDeclaration[] = [];
+  for (const n of file.getModules()) {
+    if (n.getDeclarationKind() === 'namespace') {
+      if (s === n.getName()) {
+        result.push(n);
+      }
+    }
+  }
+  return result;
+}
+
+export interface SpecType {
+  inputFile: string;
+  commandType: string;
+  modulePrefix: string;
+}
+export interface MappingInterface {
+  method: string;
+  params: string;
+  resultType: string;
+}
+
+export function getTypeInNamespaceOrThrow(
+  file: SourceFile,
+  typeWithNamespace: String,
+): TypeAliasDeclaration {
+  const [namespaceName, typeName] = typeWithNamespace.split('.') as [
+    string,
+    string,
+  ];
+
+  for (const namespace of getNamespaces(file, namespaceName)) {
+    const type = namespace.getTypeAlias(typeName);
+
+    if (type) {
+      return type;
+    }
+  }
+
+  throw new Error('Not found');
+}
+
+export function getResultNameFromMethod(method: string) {
+  const type = method
+    .split('.')
+    .map(s => s.charAt(0).toUpperCase() + s.slice(1))
+    .join('.');
+  return `${type}Result`;
+}