@soda-gql/swc-transformer 0.2.0

package/src/types/artifact.rs

@@ -0,0 +1,107 @@
+//! BuilderArtifact types ported from @soda-gql/builder.
+//!
+//! These types represent the pre-built metadata generated by the builder
+//! service during static analysis.
+
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+
+/// Canonical identifier for a GQL definition.
+/// Format: "filepath:scope.path"
+pub type CanonicalId = String;
+
+/// Metadata about the source of an artifact element.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct BuilderArtifactElementMetadata {
+    pub source_path: String,
+    pub content_hash: String,
+}
+
+/// Prebuild data for a Fragment artifact.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct FragmentPrebuild {
+    pub typename: String,
+}
+
+/// Prebuild data for an Operation artifact.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct OperationPrebuild {
+    pub operation_type: String,
+    pub operation_name: String,
+    pub variable_names: Vec<String>,
+    /// GraphQL document AST (complex object, not a string)
+    pub document: serde_json::Value,
+    #[serde(default)]
+    pub metadata: Option<serde_json::Value>,
+}
+
+/// A single artifact element from the builder.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(tag = "type", rename_all = "camelCase")]
+pub enum BuilderArtifactElement {
+    #[serde(rename = "fragment")]
+    Fragment {
+        id: CanonicalId,
+        metadata: BuilderArtifactElementMetadata,
+        prebuild: FragmentPrebuild,
+    },
+    #[serde(rename = "operation")]
+    Operation {
+        id: CanonicalId,
+        metadata: BuilderArtifactElementMetadata,
+        prebuild: OperationPrebuild,
+    },
+}
+
+#[allow(dead_code)]
+impl BuilderArtifactElement {
+    /// Get the canonical ID of this element.
+    pub fn id(&self) -> &str {
+        match self {
+            Self::Fragment { id, .. } => id,
+            Self::Operation { id, .. } => id,
+        }
+    }
+
+    /// Get the element type as a string.
+    pub fn element_type(&self) -> &'static str {
+        match self {
+            Self::Fragment { .. } => "fragment",
+            Self::Operation { .. } => "operation",
+        }
+    }
+}
+
+/// Build statistics from the builder service.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct BuilderArtifactStats {
+    pub hits: usize,
+    pub misses: usize,
+    pub skips: usize,
+}
+
+/// Build report from the builder service.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct BuilderArtifactReport {
+    pub duration_ms: u64,
+    pub warnings: Vec<String>,
+    pub stats: BuilderArtifactStats,
+}
+
+/// The complete artifact generated by the builder service.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct BuilderArtifact {
+    pub elements: HashMap<CanonicalId, BuilderArtifactElement>,
+    pub report: BuilderArtifactReport,
+}
+
+impl BuilderArtifact {
+    /// Look up an element by its canonical ID.
+    pub fn get(&self, id: &str) -> Option<&BuilderArtifactElement> {
+        self.elements.get(id)
+    }
+}

package/src/types/config.rs

@@ -0,0 +1,72 @@
+//! Configuration types for the transformer.
+
+use serde::{Deserialize, Serialize};
+
+/// Configuration for the transformer.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TransformConfig {
+    /// Aliases used to identify graphql-system imports.
+    /// e.g., ["@/graphql-system", "./graphql-system"]
+    pub graphql_system_aliases: Vec<String>,
+
+    /// Whether to generate CommonJS output.
+    /// If false, generates ESM output.
+    #[serde(default)]
+    pub is_cjs: bool,
+
+    /// The canonical path to the graphql-system file.
+    /// When the source file matches this path, it will be stubbed out.
+    /// This is resolved by the TypeScript wrapper and passed to Rust.
+    #[serde(default)]
+    pub graphql_system_path: Option<String>,
+
+    /// Whether to generate source maps.
+    /// If true, a source map will be included in the output.
+    #[serde(default)]
+    pub source_map: bool,
+}
+
+impl Default for TransformConfig {
+    fn default() -> Self {
+        Self {
+            graphql_system_aliases: vec!["@/graphql-system".to_string()],
+            is_cjs: false,
+            graphql_system_path: None,
+            source_map: false,
+        }
+    }
+}
+
+/// Input for a single file transformation (JSON-based, for one-shot transform).
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TransformInput {
+    /// The source code to transform.
+    pub source_code: String,
+
+    /// The file path of the source.
+    pub source_path: String,
+
+    /// JSON-serialized BuilderArtifact.
+    pub artifact_json: String,
+
+    /// Transformation configuration.
+    pub config: TransformConfig,
+}
+
+/// Input for a single file transformation with pre-parsed artifact.
+/// Used by SwcTransformer to avoid repeated JSON parsing.
+pub struct TransformInputRef<'a> {
+    /// The source code to transform.
+    pub source_code: String,
+
+    /// The file path of the source.
+    pub source_path: String,
+
+    /// Pre-parsed BuilderArtifact reference.
+    pub artifact: &'a super::BuilderArtifact,
+
+    /// Transformation configuration.
+    pub config: TransformConfig,
+}

package/src/types/error.rs

@@ -0,0 +1,132 @@
+//! Structured error types for the transformer.
+//!
+//! This module defines error types that match @soda-gql/plugin-common/errors.ts
+//! for consistent error reporting across TypeScript and Rust implementations.
+
+use serde::{Deserialize, Serialize};
+
+/// Stage where the error occurred.
+#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "lowercase")]
+pub enum ErrorStage {
+    Analysis,
+    Transform,
+}
+
+/// Base structure for all plugin errors.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct PluginError {
+    /// Always "PluginError" for type discrimination.
+    #[serde(rename = "type")]
+    pub error_type: String,
+
+    /// Error code for programmatic handling.
+    pub code: String,
+
+    /// Human-readable error message.
+    pub message: String,
+
+    /// Stage where the error occurred.
+    pub stage: ErrorStage,
+
+    /// Additional context about the error.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub filename: Option<String>,
+
+    /// Canonical ID if applicable.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub canonical_id: Option<String>,
+
+    /// Artifact type if applicable.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub artifact_type: Option<String>,
+
+    /// Builder type if applicable.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub builder_type: Option<String>,
+
+    /// Argument name if applicable.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub arg_name: Option<String>,
+}
+
+impl PluginError {
+    /// Create a "metadata not found" error.
+    pub fn metadata_not_found(filename: &str) -> Self {
+        Self {
+            error_type: "PluginError".to_string(),
+            code: "SODA_GQL_METADATA_NOT_FOUND".to_string(),
+            message: format!("No metadata found for gql call in '{}'", filename),
+            stage: ErrorStage::Analysis,
+            filename: Some(filename.to_string()),
+            canonical_id: None,
+            artifact_type: None,
+            builder_type: None,
+            arg_name: None,
+        }
+    }
+
+    /// Create an "artifact not found" error.
+    pub fn artifact_not_found(filename: &str, canonical_id: &str) -> Self {
+        Self {
+            error_type: "PluginError".to_string(),
+            code: "SODA_GQL_ANALYSIS_ARTIFACT_NOT_FOUND".to_string(),
+            message: format!(
+                "No artifact found for canonical ID '{}' in '{}'",
+                canonical_id, filename
+            ),
+            stage: ErrorStage::Analysis,
+            filename: Some(filename.to_string()),
+            canonical_id: Some(canonical_id.to_string()),
+            artifact_type: None,
+            builder_type: None,
+            arg_name: None,
+        }
+    }
+
+    /// Create a "missing builder arg" error.
+    pub fn missing_builder_arg(filename: &str, builder_type: &str, arg_name: &str) -> Self {
+        Self {
+            error_type: "PluginError".to_string(),
+            code: "SODA_GQL_TRANSFORM_MISSING_BUILDER_ARG".to_string(),
+            message: format!(
+                "Missing required builder argument '{}' for {} in '{}'",
+                arg_name, builder_type, filename
+            ),
+            stage: ErrorStage::Transform,
+            filename: Some(filename.to_string()),
+            canonical_id: None,
+            artifact_type: None,
+            builder_type: Some(builder_type.to_string()),
+            arg_name: Some(arg_name.to_string()),
+        }
+    }
+
+    /// Format the error into a human-readable message.
+    pub fn format(&self) -> String {
+        format!("[{}] ({:?}) {}", self.code, self.stage, self.message)
+    }
+}
+
+/// Collection of errors from a transformation.
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+pub struct TransformErrors {
+    pub errors: Vec<PluginError>,
+}
+
+impl TransformErrors {
+    pub fn new() -> Self {
+        Self { errors: Vec::new() }
+    }
+
+    pub fn push(&mut self, error: PluginError) {
+        // Log the error to stderr for visibility
+        eprintln!("[swc-transformer] {}", error.format());
+        self.errors.push(error);
+    }
+
+    pub fn is_empty(&self) -> bool {
+        self.errors.is_empty()
+    }
+}

package/src/types/mod.rs

@@ -0,0 +1,12 @@
+//! Type definitions for the SWC transformer.
+//!
+//! These types mirror the TypeScript definitions from @soda-gql/builder
+//! and @soda-gql/config packages.
+
+pub mod artifact;
+pub mod config;
+pub mod error;
+
+pub use artifact::*;
+pub use config::*;
+pub use error::*;