Jsonix Schema Compiler

Common errors

Warnings

Install

Imports

• Default
  wrong

  const Default = require('jsonix')

  correct

  import { Default } from 'jsonix'

  Jsonix itself is ESM-compatible; this is for consuming generated mappings.

• Marshaller
  wrong

  const Marshaller = require('jsonix').Marshaller

  correct

  import { Marshaller } from 'jsonix'

  Named export from jsonix.

• Unmarshaller
  wrong

  const Unmarshaller = require('jsonix').Unmarshaller

  correct

  import { Unmarshaller } from 'jsonix'

  Named export from jsonix.

• compile
  wrong

  import { compile } from 'jsonix-schema-compiler'

  correct

  // not a JS import; use CLI: java -jar jsonix-schema-compiler-full.jar

  This package provides a JAR, not a JS module. Do not attempt to import JavaScript symbols from it.

Quickstart

Shows how to use the compiler via npm prepublish and then use generated mappings with Jsonix for XML marshalling/unmarshalling.

// First, install jsonix-schema-compiler and jsonix
// npm install jsonix-schema-compiler jsonix
// Then in package.json scripts:
{
  "scripts": {
    "prepublish": "java -jar node_modules/jsonix-schema-compiler/lib/jsonix-schema-compiler-full.jar schema.xsd"
  }
}
// Run npm run prepublish to generate mapping file jsonschema.js
// Then in your code:
import { Default, Marshaller, Unmarshaller } from 'jsonix';
import { MyMapping } from './mapping/MyMapping.js';

const context = new Default([ MyMapping ]);
const marshaller = new Marshaller(context);
const unmarshaller = new Unmarshaller(context);

// Example: marshal an object to XML
const obj = { name: 'John', age: 30 };
const xml = marshaller.marshalString(obj);
console.log(xml);

// Example: unmarshal XML string
const result = unmarshaller.unmarshalString(xml);
console.log(result);