@imferno/wasm 3.0.2-beta.1b73397 → 3.0.2-beta.2427eb9

package/index.d.ts

@@ -1,68 +1,61 @@
 /**
- * Auto-initializing IMF Parser TypeScript Definitions
+ * Auto-initializing imferno WASM bindings.
  *
- * All functions automatically handle WASM initialization.
+ * Every function initialises the WASM module on first use, so all of them
+ * return Promises. Value types (`ValidationResult`, `Imferno`, `ImfReport`,
+ * `ValidateOptions`, ...) live in ./types.d.ts, generated from the Rust types
+ * by `cargo xtask generate-types-ts` and shared verbatim with @imferno/node.
  */
 
-/** Parse ASSETMAP.xml content */
-export function parseAssetmapTyped(xmlContent: string): Promise<any>;
+import type { ImfReport, Imferno, ValidateOptions, ValidationResult } from './types.js';
 
-/** Parse CPL XML content */
-export function parseCplTyped(xmlContent: string): Promise<any>;
+export * from './types.js';
 
-/** Parse PKL XML content */
-export function parsePklTyped(xmlContent: string): Promise<any>;
-
-/** Parse VOLINDEX.xml content */
-export function parseVolindexTyped(xmlContent: string): Promise<any>;
-
-/** Options for the validate function */
-export interface ValidateOptions {
-    /** Core constraints spec version: "auto" | "v2013" | "v2016" | "v2020" */
-    coreSpec?: "auto" | "v2013" | "v2016" | "v2020";
-    /** Application profile version: "auto" | "none" | "v2014" | "v2016" | "v2020" | "v2023" | "v2026" */
-    app2eSpec?: "auto" | "none" | "v2014" | "v2016" | "v2020" | "v2023" | "v2026";
-    /** ESLint-style rules configuration */
-    rules?: Record<string, string>;
-}
+/**
+ * Parse and validate an IMF package. This is the recommended entry point.
+ *
+ * Parse failures are reported as findings in `validation`, not thrown.
+ * @param files Object mapping filenames to XML string content
+ * @param options Optional validation options (spec selection, rules)
+ * @returns `{ package, validation }` — the full parsed package and all findings.
+ */
+export function validate(
+    files: Record<string, string>,
+    options?: ValidateOptions | null,
+): Promise<ValidationResult>;
 
-/** Result returned by the validate function */
-export interface ValidateResult {
-    /** Validation report with issues, compliance status, and profile */
-    report: any;
-    /** Parsed Composition Playlists */
-    cpls: any[];
-    /** Parsed AssetMap (null if parsing failed) */
-    assetMap: any | null;
-    /** Parsed Packing Lists */
-    packingLists: any[];
-    /** Parsed Volume Index (null if parsing failed) */
-    volumeIndex: any | null;
-    /** Assets in the AssetMap with no CPL or SCM reference */
-    unreferencedAssets: { id: string; path: string }[];
-    /** Sidecar assets declared in SCMs */
-    declaredSidecars: { id: string; cplIds: string[] }[];
-}
+/**
+ * Parse an IMF package without validating it.
+ * @param files Object mapping filenames to XML string content
+ * @returns The full parsed package. Rejects if the package cannot be parsed.
+ */
+export function parsePackage(files: Record<string, string>): Promise<Imferno>;
 
 /**
- * Validate a full IMF package and return both validation report and parsed data.
+ * Legacy: validate and return the lossy `ImfReport` summary. Prefer `validate`.
  * @param files Object mapping filenames to XML string content
  * @param options Optional validation options (spec selection, rules)
- * @returns Validation report + parsed package data
+ * @returns Rejects if the package cannot be parsed.
  */
-export function validate(
+export function buildReport(
     files: Record<string, string>,
-    options?: ValidateOptions,
-): Promise<ValidateResult>;
+    options?: ValidateOptions | null,
+): Promise<ImfReport>;
+
+/**
+ * Pretty-print a validation result as a human-readable string.
+ * @param report The object `validate()` returned, or (legacy) `buildReport()`'s.
+ */
+export function formatReport(report: ValidationResult | ImfReport): Promise<string>;
 
 /** Get the library version */
 export function getVersion(): Promise<string>;
 
-/** Manual WASM initialization (for advanced use) */
-export function init(wasmBuffer?: ArrayBuffer): Promise<void>;
+/**
+ * Initialise the WASM module explicitly. Optional: every function initialises
+ * on first use. Pass the `.wasm` bytes to avoid fetching them.
+ */
+export function init(wasmBytes?: ArrayBuffer | ArrayBufferView): Promise<void>;
 
 /** Typed validation code constants for use in rules config */
 export { codes } from './codes.js';
-
-/** Raw WASM bindings (for advanced use) */
-export declare const wasm: typeof import('./imferno_wasm.js');

package/index.js

@@ -18,7 +18,7 @@ function ensureInit() {
                 const __dirname = path.dirname(fileURLToPath(import.meta.url));
                 const wasmPath = path.join(__dirname, 'imferno_wasm_bg.wasm');
                 const wasmBuffer = readFileSync(wasmPath);
-                initPromise = wasmInit(wasmBuffer);
+                initPromise = wasmInit({ module_or_path: wasmBuffer });
             } catch (error) {
                 console.error('Failed to load WASM in Node.js:', error);
                 throw error;
@@ -63,6 +63,13 @@ export async function getVersion() {
 // Typed validation codes
 export { codes } from './codes.js';
 
-// For users who want manual control
-export { wasmInit as init };
-export { wasm };
+/**
+ * Initialise the WASM module explicitly (optional — every function does it on
+ * first use). Pass the `.wasm` bytes or a compiled module to skip fetching.
+ */
+export function init(wasmBytes) {
+    if (!initPromise) {
+        initPromise = wasmInit(wasmBytes === undefined ? undefined : { module_or_path: wasmBytes });
+    }
+    return initPromise.then(() => undefined);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imferno/wasm",
-  "version": "3.0.2-beta.1b73397",
+  "version": "3.0.2-beta.2427eb9",
   "description": "Fast, type-safe SMPTE ST 2067 IMF parser for JavaScript and TypeScript",
   "main": "index.js",
   "types": "index.d.ts",
@@ -14,6 +14,7 @@
     "codes.d.ts",
     "index.js",
     "index.d.ts",
+    "types.d.ts",
     "README.md",
     "LICENSE"
   ],
@@ -58,6 +59,8 @@
   },
   "devDependencies": {
     "ajv": "^8.18.0",
+    "ts-json-schema-generator": "2.9.0",
+    "typescript": "^5.9.3",
     "vitest": "^4.0.18"
   }
 }