@imferno/wasm 3.0.2-fix-working-group-resolutions.9aee1e2 → 3.0.2-fix-napi-typescript-types.ddf740f

package/README.md

@@ -17,28 +17,29 @@ The package ships a prebuilt `.wasm` binary -- no build step required.
 ## Usage
 
 ```javascript
-import { buildReport, formatReport, codes, getVersion } from '@imferno/wasm';
+import { validate, formatReport, codes, getVersion } from '@imferno/wasm';
 
 // Validate a full IMF package (pass all XML files as a map)
-const report = await buildReport({
+const result = await validate({
     'ASSETMAP.xml': assetmapXml,
     'PKL_abc.xml': pklXml,
     'CPL_def.xml': cplXml,
 });
 
-// Pretty-print the report
-console.log(await formatReport(report));
+// Pretty-print the result
+console.log(await formatReport(result));
 
 // Check compliance programmatically
-if (!report.validation.is_compliant) {
-    for (const err of report.validation.errors) {
+if (!result.validation.is_compliant) {
+    for (const err of result.validation.errors) {
         console.error(err.code, err.message);
     }
 }
 
 // Inspect package metadata
-console.log('CPL count:', report.package.cplCount);
-console.log('CPLs:', report.cpls);
+const cpls = Object.values(result.package.compositionPlaylists);
+console.log('CPL count:', cpls.length);
+console.log('Titles:', cpls.map((cpl) => cpl.contentTitle));
 
 // Get library version
 console.log(await getVersion());
@@ -72,10 +73,15 @@ WASM initialization is handled automatically on first call.
 
 | Export | Description |
 |--------|-------------|
-| `buildReport(files, options?)` | Parse and validate an IMF package, returns an `ImfReport` |
-| `formatReport(report)` | Render an `ImfReport` as a human-readable string |
+| `validate(files, options?)` | Parse and validate an IMF package, returns `{ package, validation }` (`ValidationResult`) |
+| `parsePackage(files)` | Parse without validating, returns the full package (`Imferno`) |
+| `buildReport(files, options?)` | Legacy: parse and validate, returns an `ImfReport` summary |
+| `formatReport(result)` | Render a `ValidationResult` (or legacy `ImfReport`) as a human-readable string |
 | `codes` | Typed validation code constants for use in `rules` config |
 | `getVersion()` | Get library version |
+| `init(wasmBytes?)` | Optional explicit initialisation |
+
+All value types (`ValidationResult`, `ValidationIssue`, `ValidateOptions`, ...) are exported for TypeScript.
 
 All exports are **async** (WASM must be initialized before use).
 

package/imferno_wasm.d.ts

@@ -1,486 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-export interface Asset {
-    id: ImfUuid;
-    packingList: boolean | null;
-    chunkList: ChunkList;
-}
-
-export interface AssetList {
-    assets: Asset[];
-}
-
-export interface AssetMap {
-    id: ImfUuid;
-    annotationText: string | null;
-    creator: string | null;
-    volumeCount: number;
-    issueDate: string;
-    issuer: string | null;
-    assetList: AssetList;
-}
-
-export interface AudienceElement {
-    @scope?: string | null;
-    $text?: string | null;
-}
-
-export interface AudioSubDescriptors {
-    SoundfieldGroupLabelSubDescriptor?: SoundfieldGroupLabelSubDescriptor | null;
-}
-
-export interface CDCIDescriptor {
-    InstanceUID?: string | null;
-    StoredWidth?: number | null;
-    StoredHeight?: number | null;
-    DisplayWidth?: number | null;
-    DisplayHeight?: number | null;
-    ActiveWidth?: number | null;
-    ActiveHeight?: number | null;
-    SampleRate?: EditRate | null;
-    ImageAspectRatio?: string | null;
-    ColorPrimaries?: ColorPrimaries | null;
-    TransferCharacteristic?: TransferCharacteristic | null;
-    CodingEquations?: CodingEquations | null;
-    PictureCompression?: VideoCodec | null;
-    ComponentDepth?: number | null;
-    FrameLayout?: string | null;
-    DisplayF2Offset?: number | null;
-    HorizontalSubsampling?: number | null;
-    VerticalSubsampling?: number | null;
-    ColorSiting?: number | null;
-    BlackRefLevel?: number | null;
-    WhiteRefLevel?: number | null;
-    ColorRange?: number | null;
-    StoredF2Offset?: number | null;
-    SampledWidth?: number | null;
-    SampledHeight?: number | null;
-    SampledXOffset?: number | null;
-    SampledYOffset?: number | null;
-    AlphaTransparency?: string | null;
-    ImageAlignmentOffset?: number | null;
-    ImageStartOffset?: number | null;
-    ImageEndOffset?: number | null;
-    FieldDominance?: number | null;
-    ReversedByteOrder?: string | null;
-    PaddingBits?: number | null;
-    AlphaSampleDepth?: number | null;
-    LinkedTrackID?: number | null;
-    SubDescriptors?: VideoSubDescriptors | null;
-}
-
-export interface Chunk {
-    path: string;
-    volumeIndex: number;
-}
-
-export interface ChunkList {
-    chunks: Chunk[];
-}
-
-export interface CompositionPlaylist {
-    id: ImfUuid;
-    annotation?: LanguageString | null;
-    issueDate: string;
-    issuer?: LanguageString | null;
-    creator?: LanguageString | null;
-    contentOriginator?: LanguageString | null;
-    contentTitle: LanguageString;
-    contentKind?: ContentKindElement;
-    contentVersionList?: ContentVersionList | null;
-    essenceDescriptorList?: EssenceDescriptorList | null;
-    editRate?: EditRate | null;
-    totalRunningTime?: string | null;
-    localeList?: LocaleList | null;
-    extensionProperties?: ExtensionProperties | null;
-    compositionTimecode?: CompositionTimecode | null;
-    segmentList: SegmentList;
-}
-
-export interface CompositionTimecode {
-    timecodeDropFrame: boolean | null;
-    timecodeRate: number | null;
-    timecodeStartAddress: string | null;
-}
-
-export interface ContainerConstraintsSubDescriptor {
-    InstanceID?: string | null;
-}
-
-export interface ContentKindElement {
-    kind: ContentKind;
-    scope: string | null;
-}
-
-export interface ContentMaturityRating {
-    agency: string;
-    rating?: string | null;
-    audience?: AudienceElement | null;
-}
-
-export interface ContentMaturityRatingList {
-    contentMaturityRatings: ContentMaturityRating[];
-}
-
-export interface ContentVersion {
-    id: string;
-    labelText?: LanguageString | null;
-}
-
-export interface ContentVersionList {
-    contentVersions: ContentVersion[];
-}
-
-export interface DCTimedTextDescriptor {
-    InstanceID?: string | null;
-    LinkedTrackID?: number | null;
-    SampleRate?: EditRate | null;
-    RFC5646LanguageTagList?: LanguageTag[];
-    NamespaceURI?: string | null;
-}
-
-export interface EditRate {
-    numerator: number;
-    denominator: number;
-}
-
-export interface EssenceDescriptor {
-    id: ImfUuid;
-    rgbaDescriptor?: RGBADescriptor | null;
-    cdciDescriptor?: CDCIDescriptor | null;
-    wavePCMDescriptor?: WAVEPCMDescriptor | null;
-    dcTimedTextDescriptor?: DCTimedTextDescriptor | null;
-    iabEssenceDescriptor?: IABEssenceDescriptor | null;
-    isxdDataEssenceDescriptor?: ISXDDataEssenceDescriptor | null;
-}
-
-export interface EssenceDescriptorList {
-    essenceDescriptors: EssenceDescriptor[];
-}
-
-export interface ExtensionProperties {
-    applicationIdentification?: string | null;
-    maxCLL?: number | null;
-    maxFALL?: number | null;
-}
-
-export interface ForcedNarrativeSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface HearingImpairedCaptionsSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface IABChannelSubDescriptor {
-    IABBedMetaID?: number | null;
-    IABChannelID?: number | null;
-}
-
-export interface IABEssenceDescriptor {
-    InstanceID?: string | null;
-    LinkedTrackID?: number | null;
-    SampleRate?: EditRate | null;
-    AudioSampleRate?: EditRate | null;
-    ChannelCount?: number | null;
-    QuantizationBits?: number | null;
-    ContainerFormat?: string | null;
-    SoundCompression?: string | null;
-    Codec?: string | null;
-    ElectrospatialFormulation?: number | null;
-    SubDescriptors?: IABSubDescriptors | null;
-}
-
-export interface IABSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface IABSoundfieldLabelSubDescriptor {
-    InstanceID?: string | null;
-    MCATagSymbol?: McaTagSymbol | null;
-    MCATagName?: string | null;
-    MCALabelDictionaryID?: string | null;
-    RFC5646SpokenLanguage?: LanguageTag | null;
-}
-
-export interface IABSubDescriptors {
-    IABSoundfieldLabelSubDescriptor?: IABSoundfieldLabelSubDescriptor | null;
-    IABChannelSubDescriptor?: IABChannelSubDescriptor[];
-}
-
-export interface ISXDDataEssenceDescriptor {
-    InstanceID?: string | null;
-    LinkedTrackID?: number | null;
-    SampleRate?: EditRate | null;
-    DataEssenceCoding?: string | null;
-    NamespaceURI?: string | null;
-    SubDescriptors?: IsxdSubDescriptors | null;
-}
-
-export interface ISXDSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface IsxdSubDescriptors {
-    ContainerConstraintsSubDescriptor?: ContainerConstraintsSubDescriptor | null;
-}
-
-export interface J2CLayout {
-    RGBAComponent?: RGBALayoutComponent[];
-}
-
-export interface J2KCcapi {
-    UInt16?: number[];
-}
-
-export interface J2KComponentSizing {
-    Ssiz?: number | null;
-    XRSiz?: number | null;
-    YRSiz?: number | null;
-}
-
-export interface J2KExtendedCapabilities {
-    Pcap?: number | null;
-    Ccapi?: J2KCcapi | null;
-}
-
-export interface JPEG2000SubDescriptor {
-    InstanceID?: string | null;
-    Rsiz?: number | null;
-    Xsiz?: number | null;
-    Ysiz?: number | null;
-    XOsiz?: number | null;
-    YOsiz?: number | null;
-    XTsiz?: number | null;
-    YTsiz?: number | null;
-    XTOsiz?: number | null;
-    YTOsiz?: number | null;
-    Csiz?: number | null;
-    CodingStyleDefault?: string | null;
-    QuantizationDefault?: string | null;
-    J2CLayout?: J2CLayout | null;
-    J2KExtendedCapabilities?: J2KExtendedCapabilities | null;
-    PictureComponentSizing?: PictureComponentSizing | null;
-}
-
-export interface LanguageList {
-    languages: LanguageTag[];
-}
-
-export interface LanguageString {
-    text: string;
-    language: LanguageTag | null;
-}
-
-export interface Locale {
-    languageList?: LanguageList | null;
-    regionList?: RegionList | null;
-    contentMaturityRatingList?: ContentMaturityRatingList | null;
-}
-
-export interface LocaleList {
-    locales?: Locale[];
-}
-
-export interface MainAudioSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface MainImageSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface MarkerInfo {
-    annotation?: string | null;
-    label: MarkerLabelElement;
-    offset: number;
-}
-
-export interface MarkerLabelElement {
-    label: MarkerLabel;
-    scope: string | null;
-}
-
-export interface MarkerSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface PHDRMetadataTrackSubDescriptor {
-    InstanceID?: string | null;
-    PHDRMetadataTrackSubDescriptor_DataDefinition?: string | null;
-    PHDRMetadataTrackSubDescriptor_SimplePayloadSID?: number | null;
-    PHDRMetadataTrackSubDescriptor_SourceTrackID?: number | null;
-}
-
-export interface PictureComponentSizing {
-    J2KComponentSizing?: J2KComponentSizing[];
-}
-
-export interface RGBADescriptor {
-    InstanceID?: string | null;
-    DisplayWidth?: number | null;
-    DisplayHeight?: number | null;
-    StoredWidth?: number | null;
-    StoredHeight?: number | null;
-    SampleRate?: EditRate | null;
-    ImageAspectRatio?: string | null;
-    ColorPrimaries?: ColorPrimaries | null;
-    TransferCharacteristic?: TransferCharacteristic | null;
-    CodingEquations?: CodingEquations | null;
-    PictureCompression?: VideoCodec | null;
-    FrameLayout?: string | null;
-    DisplayF2Offset?: number | null;
-    ComponentMaxRef?: number | null;
-    ComponentMinRef?: number | null;
-    ScanningDirection?: string | null;
-    StoredF2Offset?: number | null;
-    SampledWidth?: number | null;
-    SampledHeight?: number | null;
-    SampledXOffset?: number | null;
-    SampledYOffset?: number | null;
-    AlphaTransparency?: string | null;
-    ImageAlignmentOffset?: number | null;
-    ImageStartOffset?: number | null;
-    ImageEndOffset?: number | null;
-    FieldDominance?: number | null;
-    AlphaMaxRef?: number | null;
-    AlphaMinRef?: number | null;
-    Palette?: string | null;
-    PaletteLayout?: string | null;
-    LinkedTrackID?: number | null;
-    SubDescriptors?: VideoSubDescriptors | null;
-}
-
-export interface RGBALayoutComponent {
-    Code?: string;
-    ComponentSize?: number;
-}
-
-export interface RegionList {
-    regions: string[];
-}
-
-export interface Resolution {
-    width: number;
-    height: number;
-}
-
-export interface Resource {
-    id: ImfUuid;
-    annotation?: LanguageString | null;
-    editRate?: EditRate | null;
-    intrinsicDuration: number;
-    entryPoint?: number | null;
-    sourceDuration?: number | null;
-    sourceEncoding?: ImfUuid | null;
-    trackFileId?: ImfUuid | null;
-    repeatCount?: number | null;
-    keyId?: ImfUuid | null;
-    hash?: string | null;
-    markers?: MarkerInfo[];
-}
-
-export interface ResourceList {
-    resources?: Resource[];
-}
-
-export interface Segment {
-    id: ImfUuid;
-    sequenceList: SequenceList;
-}
-
-export interface SegmentList {
-    segments?: Segment[];
-}
-
-export interface SequenceList {
-    markerSequences?: MarkerSequence[];
-    mainImageSequences?: MainImageSequence[];
-    mainAudioSequences?: MainAudioSequence[];
-    subtitlesSequences?: SubtitlesSequence[];
-    hearingImpairedCaptionsSequences?: HearingImpairedCaptionsSequence[];
-    forcedNarrativeSequences?: ForcedNarrativeSequence[];
-    iabSequences?: IABSequence[];
-    isxdSequences?: ISXDSequence[];
-}
-
-export interface SoundfieldGroupLabelSubDescriptor {
-    MCATagSymbol?: McaTagSymbol | null;
-    MCATagName?: string | null;
-    MCAAudioContentKind?: string | null;
-    RFC5646SpokenLanguage?: LanguageTag | null;
-}
-
-export interface SubtitlesSequence {
-    id: ImfUuid;
-    trackId: ImfUuid;
-    resourceList: ResourceList;
-}
-
-export interface TrackInfo {
-    track_id: string;
-    track_type: string;
-    codec: string;
-    language: string | null;
-    channels: string | null;
-    format_details: string | null;
-    resolution: string | null;
-    framerate: string | null;
-    bit_depth: string | null;
-    subtitle_type: string | null;
-}
-
-export interface VideoSubDescriptors {
-    PHDRMetadataTrackSubDescriptor?: PHDRMetadataTrackSubDescriptor | null;
-    JPEG2000SubDescriptor?: JPEG2000SubDescriptor | null;
-}
-
-export interface VolumeIndex {
-    index: number;
-}
-
-export interface WAVEPCMDescriptor {
-    InstanceID?: string | null;
-    SampleRate?: EditRate | null;
-    AudioSampleRate?: EditRate | null;
-    ChannelCount?: number | null;
-    QuantizationBits?: number | null;
-    LinkedTrackID?: number | null;
-    SubDescriptors?: AudioSubDescriptors | null;
-}
-
-export type CodingEquations = "Bt601" | "Bt709" | "Bt2020Ncl" | { Unknown: string };
-
-export type ColorPrimaries = "Bt601_625" | "Bt601_525" | "Bt709" | "Bt2020" | "DciP3" | "P3D65" | { Unknown: string };
-
-export type ContentKind = "Feature" | "Trailer" | "Test" | "Promo" | "Teaser" | "RatingBump" | "Advertisement" | "Episode" | "Short" | "Commercial" | "PublicServiceAnnouncement" | { Other: string };
-
-export type CplNamespace = "Smpte2067_3_2013" | "Smpte2067_3_2016" | "Dci429_7" | { Unknown: string };
-
-export type LanguageTag = string;
-
-export type MarkerLabel = "Ffoc" | "Lfoc" | "Ffac" | "Lfac" | "Ffmc" | "Lfmc" | "Ffhc" | "Lfhc" | { Other: string };
-
-export type McaTagSymbol = "Sg51" | "Sg71" | "Sg71Ds" | "SgSt" | "SgMono" | "Iab" | "Left" | "Right" | "Center" | "Lfe" | "LeftSurround" | "RightSurround" | "LeftSideSurround" | "RightSideSurround" | "LeftRearSurround" | "RightRearSurround" | { Other: string };
-
-export type TransferCharacteristic = "Linear" | "Bt709" | "Smpte240M" | "XvYcc709" | "Bt2020" | "PqSt2084" | "Hlg" | { Unknown: string };
-
-export type VideoCodec = "Jpeg2000" | "Jpeg2000Imf2k" | "Jpeg2000Imf4k" | "Jpeg2000Imf8k" | "Jpeg2000Broadcast" | "Jpeg2000Ht" | "Vc5" | "Mpeg2" | "H264" | "H265" | "ProRes" | "Av1" | { Unknown: string };
-
 
 /**
  * Build a structured report from an IMF package.
@@ -499,10 +18,9 @@ export type VideoCodec = "Jpeg2000" | "Jpeg2000Imf2k" | "Jpeg2000Imf4k" | "Jpeg2
 export function buildReport(files: any, options: any): any;
 
 /**
- * Format a previously built `ImfReport` as a human-readable string.
+ * Format a validation result as a human-readable string.
  *
- * Pass the object returned by `buildReport()` (or any valid `ImfReport` JSON).
- * Returns the same output as `imferno report` on the CLI.
+ * Pass the object returned by `validate()`, or (legacy) by `buildReport()`.
  */
 export function formatReport(report: any): string;
 

package/imferno_wasm.js

@@ -26,10 +26,9 @@ export function buildReport(files, options) {
 }
 
 /**
- * Format a previously built `ImfReport` as a human-readable string.
+ * Format a validation result as a human-readable string.
  *
- * Pass the object returned by `buildReport()` (or any valid `ImfReport` JSON).
- * Returns the same output as `imferno report` on the CLI.
+ * Pass the object returned by `validate()`, or (legacy) by `buildReport()`.
  * @param {any} report
  * @returns {string}
  */
@@ -228,10 +227,6 @@ function __wbg_get_imports() {
             const ret = arg0[arg1 >>> 0];
             return ret;
         },
-        __wbg_get_with_ref_key_fc601247060b7204: function(arg0, arg1) {
-            const ret = arg0[arg1];
-            return ret;
-        },
         __wbg_instanceof_ArrayBuffer_12cdaa4161423e6b: function(arg0) {
             let result;
             try {

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');