oxc-project__oxc/napi/transform-relay/transform-relay.wasi.d.cts

/* auto-generated by NAPI-RS */
/* eslint-disable */

export interface Comment {
  type: 'Line' | 'Block'
  value: string
  start: number
  end: number
}

export interface ErrorLabel {
  message: string | null
  start: number
  end: number
}

export interface OxcError {
  severity: Severity
  message: string
  labels: Array<ErrorLabel>
  helpMessage: string | null
  codeframe: string | null
}

export declare const enum Severity {
  Error = 'Error',
  Warning = 'Warning',
  Advice = 'Advice',
}

export interface SourceMap {
  file?: string
  mappings: string
  names: Array<string>
  sourceRoot?: string
  sources: Array<string>
  sourcesContent?: Array<string>
  version: number
  x_google_ignoreList?: Array<number>
}

/**
 * Apply the Relay `graphql` tagged template transform asynchronously.
 *
 * This uses a worker-pool thread and can be slower than `transformSync` for a
 * single small module.
 */
export declare function transform(filename: string, sourceText: string, options?: TransformOptions | undefined | null): Promise<TransformResult>

/**
 * Options for the Relay transform.
 *
 * `lang`, `sourceType`, and `sourcemap` configure the surrounding Oxc
 * parse/codegen pipeline; the remaining fields mirror the options of
 * `babel-plugin-relay` / `@swc/plugin-relay`.
 */
export interface TransformOptions {
  /** Treat the source as `js`, `jsx`, `ts`, `tsx`, or `dts`. */
  lang?: 'js' | 'jsx' | 'ts' | 'tsx' | 'dts'
  /** Treat the source as script, module, CommonJS, or infer it from syntax. */
  sourceType?: 'script' | 'module' | 'commonjs' | 'unambiguous'
  /**
   * Generate a source map.
   *
   * @default false
   */
  sourcemap?: boolean
  /**
   * Directory `relay-compiler` emits all artifacts to (its
   * `artifactDirectory` setting). When set, artifacts are imported via a
   * relative path from the file being transformed to this directory; the
   * path is computed lexically, so both must either be absolute or relative
   * to the same base directory. When unset, artifacts are imported from the
   * `__generated__` directory next to the file being transformed.
   */
  artifactDirectory?: string
  /**
   * Artifact language, determining the imported file extension:
   * `Name.graphql.ts` for `typescript`, `Name.graphql.js` otherwise.
   *
   * @default 'javascript'
   */
  language?: 'typescript' | 'javascript' | 'flow'
  /**
   * Emit a hoisted default import per `graphql` tag instead of an inline
   * `require()` call.
   *
   * Defaults to `true`, matching `babel-plugin-relay` since Relay v17.
   * `@swc/plugin-relay` and Next.js default to `false`.
   *
   * @default true
   */
  eagerEsModules?: boolean
}

/** Result returned by the Relay transform. */
export interface TransformResult {
  /**
   * Transformed code.
   *
   * This is empty when parsing, semantic analysis, option validation, or
   * the Relay transform reports an error.
   */
  code: string
  /** Source map, populated when `sourcemap` is `true`. */
  map?: SourceMap
  /** Parse, semantic, option validation, and Relay transform diagnostics. */
  errors: Array<OxcError>
}

/**
 * Apply the Relay `graphql` tagged template transform synchronously.
 *
 * Only `graphql` tags are rewritten; TypeScript and JSX syntax are preserved
 * untouched, so the output composes with any downstream toolchain.
 */
export declare function transformSync(filename: string, sourceText: string, options?: TransformOptions | undefined | null): TransformResult