schemaorg-validate 0.3.0

Parse and validate Schema.org structured data (JSON-LD, Microdata, RDFa) against the official vocabulary and Google Rich Results profiles.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

/**
 * @schemaorg-rs/wasm — Schema.org structured data parser & validator.
 *
 * Lazy-loads the WASM binary on first use. All functions return
 * parsed JavaScript objects (the Rust side returns JSON strings,
 * this wrapper calls JSON.parse automatically).
 *
 * Usage (browser ESM):
 *   import { extract, validateHtml, schemaVersion } from '@schemaorg-rs/wasm';
 *   const result = await extract('<html>...</html>');
 *
 * Usage (Node.js):
 *   import { extract, validateHtml, schemaVersion } from '@schemaorg-rs/wasm';
 *   const result = await extract('<html>...</html>');
 */

let wasmModule = null;

/**
 * Initializes the WASM module. Called automatically on first use.
 * Can be called explicitly for eager loading.
 *
 * @param {string} [target='web'] - 'web' for browser ESM, 'nodejs' for Node.js
 * @returns {Promise<void>}
 */
export async function init(target = 'web') {
  if (wasmModule) return;

  if (target === 'nodejs') {
    const mod = await import(`./pkg/nodejs/schemaorg_rs.js`);
    wasmModule = mod;
  } else {
    const mod = await import(`./pkg/web/schemaorg_rs.js`);
    await mod.default();
    wasmModule = mod;
  }
}

/**
 * Detects the runtime environment and initializes appropriately.
 */
async function ensureInit() {
  if (wasmModule) return;

  const isNode =
    typeof globalThis.process !== 'undefined' &&
    typeof globalThis.process.versions?.node !== 'undefined';

  await init(isNode ? 'nodejs' : 'web');
}

/**
 * Extracts structured data from HTML.
 *
 * @param {string} html - The HTML document to parse
 * @returns {Promise<ExtractResult>} Parsed structured data
 */
export async function extract(html) {
  await ensureInit();
  const json = wasmModule.extract(html);
  return JSON.parse(json);
}

/**
 * Full validation pipeline: extract → validate → profile evaluate.
 *
 * @param {string} html - The HTML document to analyze
 * @param {string} [profile='google'] - Profile name ('google' or 'baseline')
 * @returns {Promise<ValidateResult>} Combined validation result
 */
export async function validateHtml(html, profile = 'google') {
  await ensureInit();
  const json = wasmModule.validate_html(html, profile);
  return JSON.parse(json);
}

/**
 * Returns the Schema.org vocabulary version used by this build.
 *
 * @returns {Promise<string>} Version string (e.g., "28.0")
 */
export async function schemaVersion() {
  await ensureInit();
  return wasmModule.schema_version();
}