oxc-transform 0.30.3 → 0.30.5

package/README.md

@@ -1,10 +1,31 @@
 # Oxc Transform
 
-## [Isolated Declarations for Standalone DTS Emit](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/#isolated-declarations)
+This is alpha software and may yield incorrect results, feel free to [submit a bug report](https://github.com/oxc-project/oxc/issues/new?assignees=&labels=C-bug&projects=&template=bug_report.md).
+
+## TypeScript and React JSX Transform
+
+```javascript
+import assert from 'assert';
+import oxc from 'oxc-transform';
+
+const { code, declaration, errors } = oxc.transform(
+  'test.ts',
+  'class A<T> {}',
+  {
+    typescript: {
+      declaration: true, // With isolated declarations in a single step.
+    },
+  },
+);
+
+assert.equal(code, 'class A {}\n');
+assert.equal(declaration, 'declare class A<T> {}\n');
+assert(errors.length == 0);
+```
 
-Based on Oxc and conforms to TypeScript Compiler's `--isolated-declaration` `.d.ts` emit.
+## [Isolated Declarations for Standalone DTS Emit](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/#isolated-declarations)
 
-This is still in alpha and may yield incorrect results, feel free to [submit a bug report](https://github.com/oxc-project/oxc/issues/new?assignees=&labels=C-bug&projects=&template=bug_report.md&title=isolated-declarations:).
+Conforms to TypeScript Compiler's `--isolated-declaration` `.d.ts` emit.
 
 ### Usage
 
@@ -12,35 +33,26 @@ This is still in alpha and may yield incorrect results, feel free to [submit a b
 import assert from 'assert';
 import oxc from 'oxc-transform';
 
-const { map, code, errors } = oxc.isolatedDeclaration('test.ts', 'class A {}', { sourcemap: true });
+const { map, code, errors } = oxc.isolatedDeclaration('test.ts', 'class A {}');
 
 assert.equal(code, 'declare class A {}\n');
-assert.deepEqual(map, {
-  mappings: 'AAAA,cAAM,EAAE,CAAE',
-  names: [],
-  sources: ['test.ts'],
-  sourcesContent: ['class A {}'],
-});
 assert(errors.length == 0);
 ```
 
 ### API
 
+See `index.d.ts`.
+
 ```typescript
+export declare function transform(
+  filename: string,
+  sourceText: string,
+  options?: TransformOptions,
+): TransformResult;
+
 export function isolatedDeclaration(
   filename: string,
   sourceText: string,
   options?: IsolatedDeclarationsOptions,
 ): IsolatedDeclarationsResult;
-
-export interface IsolatedDeclarationsOptions {
-  stripInternal?: boolean;
-  sourcemap?: boolean;
-}
-
-export interface IsolatedDeclarationsResult {
-  code: string;
-  map?: SourceMap;
-  errors: Array<string>;
-}
 ```

package/index.d.ts

@@ -124,8 +124,14 @@ export interface ReactBindingOptions {
    * @default false
    */
   useSpread?: boolean
-  /** Enable react fast refresh transform */
-  refresh?: ReactRefreshBindingOptions
+  /**
+   * Enable React Fast Refresh .
+   *
+   * Conforms to the implementation in {@link https://github.com/facebook/react/tree/main/packages/react-refresh}
+   *
+   * @default false
+   */
+  refresh?: boolean | ReactRefreshBindingOptions
 }
 
 export interface ReactRefreshBindingOptions {
@@ -146,11 +152,11 @@ export interface ReactRefreshBindingOptions {
 
 export interface SourceMap {
   file?: string
-  mappings?: string
-  names?: Array<string>
+  mappings: string
+  names: Array<string>
   sourceRoot?: string
-  sources?: Array<string | undefined | null>
-  sourcesContent?: Array<string | undefined | null>
+  sources: Array<string>
+  sourcesContent?: Array<string>
   version: number
   x_google_ignoreList?: Array<number>
 }
@@ -181,18 +187,12 @@ export interface TransformOptions {
    * options.
    */
   cwd?: string
-  /**
-   * Force jsx parsing,
-   *
-   * @default false
-   */
-  jsx?: boolean
   /** Configure how TypeScript is transformed. */
   typescript?: TypeScriptBindingOptions
   /** Configure how TSX and JSX are transformed. */
   react?: ReactBindingOptions
   /** Enable ES2015 transformations. */
-  es2015?: Es2015BindingOptions
+  es2015?: ES2015BindingOptions
   /**
    * Enable source map generation.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oxc-transform",
-  "version": "0.30.3",
+  "version": "0.30.5",
   "description": "Oxc transform Node API",
   "keywords": [
     "transform"
@@ -23,13 +23,13 @@
     "index.js"
   ],
   "optionalDependencies": {
-    "@oxc-transform/binding-win32-x64-msvc": "0.30.3",
-    "@oxc-transform/binding-win32-arm64-msvc": "0.30.3",
-    "@oxc-transform/binding-linux-x64-gnu": "0.30.3",
-    "@oxc-transform/binding-linux-arm64-gnu": "0.30.3",
-    "@oxc-transform/binding-linux-x64-musl": "0.30.3",
-    "@oxc-transform/binding-linux-arm64-musl": "0.30.3",
-    "@oxc-transform/binding-darwin-x64": "0.30.3",
-    "@oxc-transform/binding-darwin-arm64": "0.30.3"
+    "@oxc-transform/binding-win32-x64-msvc": "0.30.5",
+    "@oxc-transform/binding-win32-arm64-msvc": "0.30.5",
+    "@oxc-transform/binding-linux-x64-gnu": "0.30.5",
+    "@oxc-transform/binding-linux-arm64-gnu": "0.30.5",
+    "@oxc-transform/binding-linux-x64-musl": "0.30.5",
+    "@oxc-transform/binding-linux-arm64-musl": "0.30.5",
+    "@oxc-transform/binding-darwin-x64": "0.30.5",
+    "@oxc-transform/binding-darwin-arm64": "0.30.5"
   }
 }