@graphox/swc-plugin 0.2.0

package/README.md

@@ -0,0 +1,160 @@
+# @graphox/swc-plugin
+
+## Overview
+
+Pre-built SWC plugin for Graphox codesplitting. This package bundles the WASM binary for easy use with rsbuild, Turbopack, or native SWC.
+
+## Prerequisites
+
+Building the WASM plugin from source requires:
+
+- **Rust toolchain** (1.70+): `rustup install stable`
+- **WASM target**: `rustup target add wasm32-wasip1`
+- **wasm-pack**: `cargo install wasm-pack`
+- **Node.js** 18+
+- **pnpm**: `corepack enable && corepack install -g pnpm@latest`
+
+For users of the pre-built package, only Node.js 18+ is required.
+
+## Installation
+
+```bash
+pnpm add @graphox/swc-plugin
+```
+
+## Requirements
+
+- Node.js 18+
+- rsbuild, Turbopack, or native SWC
+
+## Usage
+
+### rsbuild Configuration
+
+```typescript
+// rsbuild.config.ts
+import { defineConfig } from '@rsbuild/core';
+import { createSWCPlugin } from '@graphox/swc-plugin';
+import path from 'path';
+
+export default defineConfig({
+  source: {
+    alias: {
+      '__generated__': path.resolve(__dirname, './__generated__'),
+    },
+  },
+  tools: {
+    swc: {
+      jsc: {
+        parser: {
+          syntax: 'typescript',
+          tsx: true,
+        },
+        experimental: {
+          plugins: [
+            createSWCPlugin({
+              manifestPath: './__generated__/manifest.json',
+              outputDir: './__generated__'
+            })
+          ],
+        },
+      },
+    },
+  },
+});
+```
+
+### Turbopack/Next.js Configuration
+
+```javascript
+// next.config.js
+import { createSWCPlugin } from '@graphox/swc-plugin';
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    turbo: {
+      rules: {
+        '*.{ts,tsx}': [
+          {
+            loader: 'next-swc-loader',
+            options: {
+              jsc: {
+                parser: {
+                  syntax: 'typescript',
+                  tsx: true,
+                },
+                experimental: {
+                  plugins: [
+                    createSWCPlugin({
+                      manifestPath: './__generated__/manifest.json',
+                      outputDir: './__generated__'
+                    })
+                  ],
+                },
+              },
+            },
+          },
+        ],
+      },
+    },
+  },
+};
+
+module.exports = nextConfig;
+```
+
+## Configuration Options
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `manifestPath` | `string` | Yes* | Path to `manifest.json` generated by codegen |
+| `manifestData` | `object[]` | Yes* | Inline manifest data (alternative to `manifestPath`) |
+| `outputDir` | `string` | Yes | Directory containing generated files |
+| `graphqlImportPaths` | `string[]` | No | Explicit import paths to treat as GraphQL entrypoints |
+| `emitExtensions` | `string` | No | File extension for generated imports: `"none"` (default), `"ts"`, `"js"`, `"dts"` |
+
+*Either `manifestPath` or `manifestData` is required.
+
+### emitExtensions
+
+Controls the file extension appended to generated import paths. Should match the `emit_extensions` setting in your `graphox.yaml`:
+
+| Value | Result |
+|-------|--------|
+| `"none"` (default) | `import { X } from "./file.codegen"` |
+| `"ts"` | `import { X } from "./file.codegen.ts"` |
+| `"js"` | `import { X } from "./file.codegen.js"` |
+| `"dts"` | `import { X } from "./file.codegen.d.ts"` |
+
+## Fragment Documents
+
+When `generate_ast_for_fragments: true` is enabled in your config, fragment documents are also included in the manifest and will be properly rewritten by the plugin.
+
+## Building from Source
+
+If you need to rebuild the WASM plugin:
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build TypeScript only (requires pre-built WASM)
+pnpm run build
+
+# Build WASM only (requires Rust toolchain)
+pnpm run build:wasm
+
+# Build everything (TypeScript + WASM)
+pnpm run build:all
+
+# Run tests
+pnpm test
+```
+
+## See Also
+
+- [Babel Plugin](../babel/README.md)
+- [graphox CLI](../../README.md)
+- [Configuration Guide](../../docs/configurations.md)
+- [Plugin Development Guide](../../../docs/plugin-development.md)

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+/**
+ * SWC GraphQL Plugin - Node.js WASM Wrapper
+ *
+ * This package provides a convenient Node.js interface to the SWC GraphQL plugin.
+ * The actual transformation logic is implemented in Rust and compiled to WASM.
+ *
+ * @example
+ * // rsbuild.config.ts
+ * import { defineConfig } from '@rsbuild/core';
+ * import { createSWCPlugin } from '@graphox/swc-plugin';
+ *
+ * export default defineConfig({
+ *   tools: {
+ *     swc: {
+ *       jsc: {
+ *         experimental: {
+ *           plugins: [
+ *             createSWCPlugin({
+ *               manifestPath: './__generated__/manifest.json',
+ *               outputDir: './__generated__'
+ *             })
+ *           ]
+ *         }
+ *       }
+ *     }
+ *   }
+ * });
+ */
+/**
+ * Configuration options for the SWC GraphQL plugin.
+ */
+export interface PluginConfig {
+    /**
+     * Path to the manifest.json file generated by graphox codegen.
+     * The manifest maps GraphQL source code to generated document files.
+     */
+    manifestPath?: string;
+    /**
+     * Inline manifest data. Can be used instead of manifestPath.
+     * Takes precedence over manifestPath if both are provided.
+     */
+    manifestData?: Array<{
+        source: string;
+        path: string;
+        name: string;
+    }>;
+    /**
+     * Directory where generated files are located.
+     * Used for resolving relative paths and detecting imports.
+     */
+    outputDir: string;
+    /**
+     * Additional import paths to treat as GraphQL entrypoints.
+     * Useful for path aliases like '@/graphql'.
+     */
+    graphqlImportPaths?: string[];
+    /**
+     * File extension to append to generated import paths.
+     * Options: "Ts", "Dts", "Js" or None (default)
+     */
+    emitExtensions?: 'Ts' | 'Dts' | 'Js' | 'None';
+}
+/**
+ * Load the manifest from disk or return inline data.
+ *
+ * @param config - Plugin configuration
+ * @returns Parsed manifest entries
+ */
+export declare function loadManifest(config: PluginConfig): Array<{
+    source: string;
+    path: string;
+    name: string;
+}>;
+/**
+ * Create a SWC plugin configuration.
+ *
+ * Returns a tuple [wasmPath, options] that can be passed directly to SWC's
+ * experimental plugins configuration.
+ */
+export declare function createSWCPlugin(config: PluginConfig): [string, PluginConfig];
+/**
+ * Validate that the WASM plugin is available.
+ *
+ * @returns true if WASM is built and available
+ */
+export declare function isWasmAvailable(): boolean;
+export default createSWCPlugin;

package/dist/index.js

@@ -0,0 +1,99 @@
+/**
+ * SWC GraphQL Plugin - Node.js WASM Wrapper
+ *
+ * This package provides a convenient Node.js interface to the SWC GraphQL plugin.
+ * The actual transformation logic is implemented in Rust and compiled to WASM.
+ *
+ * @example
+ * // rsbuild.config.ts
+ * import { defineConfig } from '@rsbuild/core';
+ * import { createSWCPlugin } from '@graphox/swc-plugin';
+ *
+ * export default defineConfig({
+ *   tools: {
+ *     swc: {
+ *       jsc: {
+ *         experimental: {
+ *           plugins: [
+ *             createSWCPlugin({
+ *               manifestPath: './__generated__/manifest.json',
+ *               outputDir: './__generated__'
+ *             })
+ *           ]
+ *         }
+ *       }
+ *     }
+ *   }
+ * });
+ */
+import * as path from 'path';
+import * as fs from 'fs';
+/**
+ * Get the path to the WASM plugin.
+ *
+ * The WASM file is built from the Rust source in ../rust/
+ * and bundled with this package.
+ */
+function getWasmPath() {
+    // The WASM file should be in the wasm/ directory after building
+    const wasmPath = path.join(__dirname, '..', 'wasm', 'graphox_swc_plugin.wasm');
+    if (!fs.existsSync(wasmPath)) {
+        throw new Error(`WASM plugin not found at ${wasmPath}. ` +
+            'Run "pnpm run build:wasm" to build the plugin.');
+    }
+    return wasmPath;
+}
+/**
+ * Load the manifest from disk or return inline data.
+ *
+ * @param config - Plugin configuration
+ * @returns Parsed manifest entries
+ */
+export function loadManifest(config) {
+    if (config.manifestData) {
+        return config.manifestData;
+    }
+    if (config.manifestPath && fs.existsSync(config.manifestPath)) {
+        const content = fs.readFileSync(config.manifestPath, 'utf-8');
+        const data = JSON.parse(content);
+        return Array.isArray(data) ? data : (data.entries || []);
+    }
+    return [];
+}
+/**
+ * Create a SWC plugin configuration.
+ *
+ * Returns a tuple [wasmPath, options] that can be passed directly to SWC's
+ * experimental plugins configuration.
+ */
+export function createSWCPlugin(config) {
+    // Validate required fields first
+    if (!config.outputDir) {
+        throw new Error('outputDir is required in PluginConfig');
+    }
+    const wasmPath = getWasmPath();
+    // Inline manifest data to ensure it's available to the WASM plugin
+    // since WASM plugins may not have filesystem access.
+    const inlinedConfig = {
+        ...config,
+        manifestData: loadManifest(config)
+    };
+    // Return tuple for SWC
+    return [wasmPath, inlinedConfig];
+}
+/**
+ * Validate that the WASM plugin is available.
+ *
+ * @returns true if WASM is built and available
+ */
+export function isWasmAvailable() {
+    try {
+        getWasmPath();
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+// Default export
+export default createSWCPlugin;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@graphox/swc-plugin",
+  "version": "0.2.0",
+  "description": "SWC plugin for GraphQL Rust codesplitting",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "wasm/",
+    "README.md"
+  ],
+  "keywords": [
+    "graphql",
+    "swc",
+    "plugin",
+    "codegen",
+    "codesplitting"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/soundtrackyourbrand/graphox",
+    "directory": "plugins/swc/node"
+  },
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "tsc",
+    "build:wasm": "wasm-pack build ../rust --target nodejs --out-dir $PWD/wasm --no-pack",
+    "build:all": "pnpm run build:wasm && pnpm run build",
+    "test": "vitest run"
+  }
+}