@wix/zero-config-implementation 1.35.0 → 1.37.0

package/README.md

@@ -15,19 +15,24 @@ Peer dependencies: `react` (^18 || ^19), `react-dom` (^18 || ^19), `typescript`
 ### Programmatic
 
 ```ts
-import { extractComponentManifest } from '@wix/zero-config'
+import { extractComponentManifest, extractComponentManifestResult } from '@wix/zero-config'
 
-const result = await extractComponentManifest(
+const manifest = await extractComponentManifest(
   './src/MyComponent.tsx',
   './dist/index.js', // path to the compiled JS entry of the component's package
 )
 
+console.log(manifest.component) // EditorReactComponent
+console.log(manifest.errors) // non-fatal ExtractionError[]
+
+// If you prefer neverthrow ResultAsync semantics:
+const result = await extractComponentManifestResult('./src/MyComponent.tsx', './dist/index.js')
 result.match(
-  (manifest) => {
-    console.log(manifest.component) // EditorReactComponent
-    console.log(manifest.errors)    // non-fatal ExtractionError[]
+  (manifestResult) => {
+    console.log(manifestResult.component)
+    console.log(manifestResult.errors)
   },
-  (err) => console.error(err),
+  (error) => console.error(error),
 )
 ```
 
@@ -53,7 +58,8 @@ npx @wix/zero-config
 
 ## API layers
 
-- **Tier 1 — High-level:** `extractComponentManifest()` — one call, default pipeline.
+- **Tier 1 — High-level:** `extractComponentManifest()` — one call, default pipeline (`Promise<ManifestResult>`).
+- **Tier 1 (neverthrow variant):** `extractComponentManifestResult()` — same pipeline with `ResultAsync` return.
 - **Tier 2 — Pipeline building blocks:** `compileTsFile`, `extractAllComponentInfo`, `extractCssImports`, `processComponent`, `runExtractors`, `ExtractorStore`, `buildElementTree`, `createPropTrackerExtractor`, `createCssPropertiesExtractor`, `parseCss`, `toEditorReactComponent`, and exported types (e.g. `ComponentInfo`, `PropInfo`, `ExtractionResult`, `ReactExtractor`).
 - **Tier 3 — Low-level:** `renderWithExtractors`, `CreateElementListener` for custom createElement/JSX interception.
 

package/dist/index.d.ts

@@ -813,7 +813,7 @@ declare type ExternalPluginsOptions<PluginsArg extends Plugins> = {
 
 export declare function extractAllComponentInfo(program: default_2.Program, filePath: string): ComponentInfo[];
 
-export declare function extractComponentManifest(componentPath: string, compiledEntryPath: string, options?: ExtractComponentManifestOptions): ResultAsync<ManifestResult, InstanceType<typeof NotFoundError> | InstanceType<typeof ParseError>>;
+export declare function extractComponentManifest(componentPath: string, compiledEntryPath: string, options?: ExtractComponentManifestOptions): Promise<ManifestResult>;
 
 /**
  * Extract component manifest from a TypeScript source file.
@@ -829,6 +829,8 @@ export declare interface ExtractComponentManifestOptions extends RunExtractorsOp
     onError?: (error: ExtractionError) => void;
 }
 
+export declare function extractComponentManifestResult(componentPath: string, compiledEntryPath: string, options?: ExtractComponentManifestOptions): ResultAsync<ManifestResult, InstanceType<typeof NotFoundError> | InstanceType<typeof ParseError>>;
+
 export declare function extractCssImports(program: Program): string[];
 
 /**