cddl2java 0.0.0

package/build/templates.js

@@ -0,0 +1,252 @@
+/**
+ * Java code templates for WebDriver BiDi Java code generation
+ */
+export const emptyResultTemplate = `package org.openqa.selenium.bidirectional;
+
+/**
+ * Represents an empty result from a WebDriver BiDi command
+ */
+public class EmptyResult {
+    /**
+     * Creates a new EmptyResult instance
+     */
+    public EmptyResult() {
+        // Empty result has no properties
+    }
+}
+`;
+export const contextValueTemplate = `package org.openqa.selenium.bidirectional;
+
+import java.util.Map;
+import java.util.HashMap;
+
+/**
+ * Represents a value with context in WebDriver BiDi protocol
+ */
+public class ContextValue {
+    private final String context;
+    private final Map<String, Object> additionalProperties = new HashMap<>();
+
+    /**
+     * Creates a new ContextValue instance
+     * @param context The context ID (typically a browsing context ID)
+     */
+    public ContextValue(String context) {
+        this.context = context;
+    }
+
+    /**
+     * Gets the context property
+     * @return Context ID value
+     */
+    public String getContext() {
+        return context;
+    }
+
+    /**
+     * Adds an additional property to this value
+     * @param key Property name
+     * @param value Property value
+     */
+    public void addProperty(String key, Object value) {
+        additionalProperties.put(key, value);
+    }
+
+    /**
+     * Converts this object to a map for use with BiDi protocol
+     * @return Map representation of this object
+     */
+    public Map<String, Object> asMap() {
+        Map<String, Object> result = new HashMap<>(additionalProperties);
+        result.put("context", context);
+        return result;
+    }
+}`;
+export const accessibilityValueTemplate = `package org.openqa.selenium.bidirectional;
+
+import java.util.Map;
+import java.util.HashMap;
+
+/**
+ * Represents a value with accessibility properties in WebDriver BiDi protocol
+ */
+public class AccessibilityValue {
+    private final String name;
+    private final String role;
+    private final Map<String, Object> additionalProperties = new HashMap<>();
+
+    /**
+     * Creates a new AccessibilityValue instance
+     * @param name The accessible name
+     * @param role The accessible role
+     */
+    public AccessibilityValue(String name, String role) {
+        this.name = name;
+        this.role = role;
+    }
+
+    /**
+     * Gets the name property
+     * @return Name value
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Gets the role property
+     * @return Role value
+     */
+    public String getRole() {
+        return role;
+    }
+
+    /**
+     * Adds an additional property to this value
+     * @param key Property name
+     * @param value Property value
+     */
+    public void addProperty(String key, Object value) {
+        additionalProperties.put(key, value);
+    }
+
+    /**
+     * Converts this object to a map for use with BiDi protocol
+     * @return Map representation of this object
+     */
+    public Map<String, Object> asMap() {
+        Map<String, Object> result = new HashMap<>(additionalProperties);
+        if (name != null) {
+            result.put("name", name);
+        }
+        if (role != null) {
+            result.put("role", role);
+        }
+        return result;
+    }
+}`;
+export const getEnumTemplate = (name, enums) => {
+    return `/**
+ * Represents ${name} in WebDriver BiDi protocol
+ * as enum of "${enums.join('" / "')}"
+ */
+public enum ${name} {
+    ${enums.map((e) => {
+        if (e.includes('.')) {
+            const [, prop] = e.split('.');
+            return `${prop.toUpperCase()}(${prop}.class);`;
+        }
+        if (e.startsWith('-')) {
+            return `NEGATIVE_${e.slice(1).toUpperCase()}("${e}");`;
+        }
+        return `${e.toUpperCase()}("${e}");`;
+    }).join('\n    ')}
+
+    private final String value;
+
+    ${name}(String value) {
+        this.value = value;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public static ${name} fromString(String text) {
+        for (${name} ${name.toLowerCase()} : ${name}.values()) {
+            if (${name.toLowerCase()}.value.equalsIgnoreCase(text)) {
+                return ${name.toLowerCase()};
+            }
+        }
+        throw new IllegalArgumentException("No ${name} with value: " + text);
+    }
+}`;
+};
+export const capabilitiesTemplate = `package org.openqa.selenium.bidirectional.session;
+
+import java.util.Map;
+import java.util.HashMap;
+
+/**
+ * Represents browser capabilities in WebDriver BiDi protocol
+ */
+public class Capabilities {
+    private final Map<String, Object> capabilities;
+
+    public Capabilities(Map<String, Object> capabilities) {
+        this.capabilities = capabilities != null ? capabilities : new HashMap<>();
+    }
+
+    public Boolean getAcceptInsecureCerts() {
+        return (Boolean) capabilities.get("acceptInsecureCerts");
+    }
+
+    public String getBrowserName() {
+        return (String) capabilities.get("browserName");
+    }
+
+    public String getBrowserVersion() {
+        return (String) capabilities.get("browserVersion");
+    }
+
+    public String getPlatformName() {
+        return (String) capabilities.get("platformName");
+    }
+
+    public Boolean getSetWindowRect() {
+        return (Boolean) capabilities.get("setWindowRect");
+    }
+
+    public String getUserAgent() {
+        return (String) capabilities.get("userAgent");
+    }
+
+    public String getWebSocketUrl() {
+        return (String) capabilities.get("webSocketUrl");
+    }
+
+    public Map<String, Object> asMap() {
+        return new HashMap<>(capabilities);
+    }
+}`;
+export const newResultTemplate = `package org.openqa.selenium.bidirectional.session;
+
+import java.util.Map;
+
+/**
+ * Result for session.New command.
+ * Auto-generated from the CDDL specification.
+ */
+public class NewResult {
+    private final String sessionId;
+    private final Capabilities capabilities;
+
+    /**
+     * Constructor for NewResult.
+     *
+     * @param sessionId The session ID
+     * @param capabilities The capabilities map
+     */
+    public NewResult(String sessionId, Map<String, Object> capabilities) {
+        this.sessionId = sessionId;
+        this.capabilities = new Capabilities(capabilities);
+    }
+
+    /**
+     * Get the session ID.
+     *
+     * @return The session ID
+     */
+    public String getSessionId() {
+        return sessionId;
+    }
+
+    /**
+     * Get the capabilities.
+     *
+     * @return The capabilities
+     */
+    public Capabilities getCapabilities() {
+        return capabilities;
+    }
+}`;

package/build/utils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * write generated ts file so it
+ *   - passes our eslint rules (no crlf)
+ *   - and has a note at the top that the file is generated
+ *
+ * @param filePath path to file to write
+ * @param content content of file
+ */
+export declare function writeFile(filePath: string, content: string): Promise<void>;
+export declare function pascalCase(name: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,iBAKjE;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,UAEtC"}

package/build/utils.js

@@ -0,0 +1,17 @@
+import fs from 'node:fs/promises';
+import { GENERATED_FILE_COMMENT } from './constants.js';
+import camelcase from 'camelcase';
+/**
+ * write generated ts file so it
+ *   - passes our eslint rules (no crlf)
+ *   - and has a note at the top that the file is generated
+ *
+ * @param filePath path to file to write
+ * @param content content of file
+ */
+export async function writeFile(filePath, content) {
+    return fs.writeFile(filePath, GENERATED_FILE_COMMENT + '\n\n' + content.replace(/\r\n/g, '\n'));
+}
+export function pascalCase(name) {
+    return camelcase(name, { pascalCase: true });
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "cddl2java",
+  "version": "0.0.0",
+  "description": "A Node.js package that can generates Java classes based on a CDDL file",
+  "author": "Christian Bromann <mail@bromann.dev>",
+  "license": "MIT",
+  "homepage": "https://github.com/webdriverio/cddl/blob/main/packages/cddl2java/README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/webdriverio/cddl.git"
+  },
+  "keywords": [
+    "cddl",
+    "typescript",
+    "java"
+  ],
+  "bugs": {
+    "url": "https://github.com/webdriverio/cddl/issues"
+  },
+  "type": "module",
+  "exports": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "bin": {
+    "cddl2java": "./bin/cddl2java.js"
+  },
+  "scripts": {
+    "release": "release-it --config .release-it.ts --VV",
+    "release:ci": "pnpm release --ci --npm.skipChecks"
+  },
+  "devDependencies": {
+    "@types/yargs": "^17.0.35",
+    "@types/node": "^25.5.0"
+  },
+  "dependencies": {
+    "@babel/parser": "^7.29.0",
+    "camelcase": "^9.0.0",
+    "cddl": "workspace:*",
+    "recast": "^0.23.11",
+    "yargs": "^18.0.0"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,42 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+
+import { transform } from './index.js'
+import { pkg } from './constants.js'
+
+const HELP = `
+${pkg.name}
+${pkg.description}
+
+Usage:
+runme2java ./path/to/spec.cddl &> ./outputDir
+
+v${pkg.version}
+Copyright ${(new Date()).getFullYear()} ${pkg.author}
+`
+
+export default async function cli (args = process.argv.slice(2)) {
+    if (args.includes('--help') || args.length === 0) {
+        console.log(HELP);
+        return process.exit(0)
+    }
+    if (args.includes('--version') || args.includes('-v')) {
+        console.log(pkg.version);
+        return process.exit(0)
+    }
+
+    const cddlFilePath = path.isAbsolute(args[0]) ? args[0] : path.resolve(process.cwd(), args[0])
+    const hasAccess = await fs.access(cddlFilePath).then(() => true, () => false)
+    if (!hasAccess) {
+        console.error(`Couldn't find or access source CDDL file at "${cddlFilePath}"`)
+        return process.exit(1)
+    }
+
+    const outputDir = path.isAbsolute(args[1]) ? args[1] : path.resolve(process.cwd(), args[1])
+    const hasAccessOutputDir = await fs.access(outputDir).then(() => true, () => false)
+    if (!hasAccessOutputDir) {
+        await fs.mkdir(outputDir, { recursive: true })
+    }
+
+    return transform(cddlFilePath, outputDir)
+}

package/src/constants.ts

@@ -0,0 +1,25 @@
+import fs from 'node:fs/promises'
+import url from 'node:url'
+import path from 'node:path'
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+export const pkg = JSON.parse(await fs.readFile(path.join(__dirname, '..', 'package.json'), 'utf-8'))
+
+export const GENERATED_FILE_COMMENT = `/**
+ * !!! PLEASE DO NOT EDIT THIS FILE !!!
+ *
+ * This source file, even though checked in, is auto-generated based on the
+ * current development within the WebDriver Bidi spec. Any changes to this
+ * file need to come from the specification.
+ */`
+
+export const CDDL_PARSE_ERROR_MESSAGE = `
+====================
+CDDL PARSING FAILED!
+====================
+
+No updates to the CDDL interface can be applied as the script failed to parse
+the spec CDDL due to the following error:
+
+%s
+`