@imferno/schema 0.1.2

package/README.md

@@ -0,0 +1,52 @@
+# @imferno/schema
+
+JSON Schema definitions for SMPTE ST 2067 (IMF) types. Use these schemas to validate the JSON output from [`imferno`](https://www.npmjs.com/package/imferno) or [`@imferno/wasm`](https://www.npmjs.com/package/@imferno/wasm).
+
+## Install
+
+```bash
+npm install @imferno/schema
+```
+
+## Usage
+
+```js
+import Ajv from "ajv";
+import { imfReport } from "@imferno/schema";
+
+const ajv = new Ajv();
+const validate = ajv.compile(imfReport);
+
+const data = JSON.parse(imfernoOutput);
+if (validate(data)) {
+  console.log("Valid IMF report");
+} else {
+  console.error(validate.errors);
+}
+```
+
+## Available Schemas
+
+| Export | Description |
+|--------|-------------|
+| `imfReport` | Full IMF package report (source assets + validation + delivery comparison) |
+| `validationReport` | Validation issues and diagnostics |
+| `compositionPlaylist` | SMPTE ST 2067-3 Composition Playlist |
+| `assetMap` | SMPTE ST 2067-2 Asset Map |
+| `packingList` | SMPTE ST 2067-2 Packing List |
+| `volumeIndex` | SMPTE ST 429-9 Volume Index |
+| `sourceAsset` | Extracted source asset metadata (tracks, formats, durations) |
+| `deliveryRequest` | Delivery specification request |
+| `deliveryComparison` | Delivery comparison result |
+| `rulesConfig` | ESLint-style rules configuration for validation |
+
+All schemas are also available via the `schemas` named export:
+
+```js
+import { schemas } from "@imferno/schema";
+// schemas.imfReport, schemas.assetMap, etc.
+```
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,26 @@
+/** A JSON Schema object (Draft 7). */
+type JsonSchema = Record<string, unknown>;
+
+export declare const imfReport: JsonSchema;
+export declare const validationReport: JsonSchema;
+export declare const compositionPlaylist: JsonSchema;
+export declare const assetMap: JsonSchema;
+export declare const packingList: JsonSchema;
+export declare const volumeIndex: JsonSchema;
+export declare const sourceAsset: JsonSchema;
+export declare const deliveryRequest: JsonSchema;
+export declare const deliveryComparison: JsonSchema;
+export declare const rulesConfig: JsonSchema;
+
+export declare const schemas: {
+  imfReport: JsonSchema;
+  validationReport: JsonSchema;
+  compositionPlaylist: JsonSchema;
+  assetMap: JsonSchema;
+  packingList: JsonSchema;
+  volumeIndex: JsonSchema;
+  sourceAsset: JsonSchema;
+  deliveryRequest: JsonSchema;
+  deliveryComparison: JsonSchema;
+  rulesConfig: JsonSchema;
+};

package/index.js

@@ -0,0 +1,34 @@
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { dirname, join } from "node:path";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const schemasDir = join(__dirname, "schemas");
+
+function loadSchema(name) {
+  return JSON.parse(readFileSync(join(schemasDir, `${name}.json`), "utf-8"));
+}
+
+export const imfReport = loadSchema("imf-report");
+export const validationReport = loadSchema("validation-report");
+export const compositionPlaylist = loadSchema("composition-playlist");
+export const assetMap = loadSchema("asset-map");
+export const packingList = loadSchema("packing-list");
+export const volumeIndex = loadSchema("volume-index");
+export const sourceAsset = loadSchema("source-asset");
+export const deliveryRequest = loadSchema("delivery-request");
+export const deliveryComparison = loadSchema("delivery-comparison");
+export const rulesConfig = loadSchema("rules-config");
+
+export const schemas = {
+  imfReport,
+  validationReport,
+  compositionPlaylist,
+  assetMap,
+  packingList,
+  volumeIndex,
+  sourceAsset,
+  deliveryRequest,
+  deliveryComparison,
+  rulesConfig,
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@imferno/schema",
+  "version": "0.1.2",
+  "description": "JSON Schema definitions for SMPTE ST 2067 IMF types — validates imferno export output",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "type": "module",
+  "files": [
+    "schemas/",
+    "index.js",
+    "index.d.ts"
+  ],
+  "keywords": [
+    "imf",
+    "imferno",
+    "smpte",
+    "st2067",
+    "json-schema",
+    "validation",
+    "typescript",
+    "schema"
+  ],
+  "author": {
+    "name": "JP Wesselink",
+    "email": "jp@wesselink.dev"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jpwesselink/imferno.git",
+    "directory": "crates/imferno-core/npm/schema"
+  },
+  "bugs": {
+    "url": "https://github.com/jpwesselink/imferno/issues"
+  },
+  "homepage": "https://github.com/jpwesselink/imferno",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/schemas/asset-map.json

@@ -0,0 +1,136 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "AssetMap",
+  "description": "ASSETMAP.xml — maps UUIDs to physical file paths (ST 429-9 §6).",
+  "type": "object",
+  "required": [
+    "asset_list",
+    "id",
+    "issue_date",
+    "volume_count"
+  ],
+  "properties": {
+    "annotation_text": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "asset_list": {
+      "$ref": "#/definitions/AssetList"
+    },
+    "creator": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "id": {
+      "description": "Unique identifier for this AssetMap (ST 429-9 §6.2).",
+      "allOf": [
+        {
+          "$ref": "#/definitions/ImfUuid"
+        }
+      ]
+    },
+    "issue_date": {
+      "description": "ISO 8601 issue date (e.g. `\"2016-10-06T08:35:02-00:00\"`).",
+      "type": "string"
+    },
+    "issuer": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "volume_count": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0.0
+    }
+  },
+  "definitions": {
+    "Asset": {
+      "description": "A single asset entry in ASSETMAP.xml.",
+      "type": "object",
+      "required": [
+        "chunk_list",
+        "id"
+      ],
+      "properties": {
+        "chunk_list": {
+          "$ref": "#/definitions/ChunkList"
+        },
+        "id": {
+          "description": "UUID identifying this asset.",
+          "allOf": [
+            {
+              "$ref": "#/definitions/ImfUuid"
+            }
+          ]
+        },
+        "packing_list": {
+          "description": "Present and `true` when this entry refers to the Packing List file.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        }
+      }
+    },
+    "AssetList": {
+      "description": "The `<AssetList>` element in ASSETMAP.xml.",
+      "type": "object",
+      "required": [
+        "assets"
+      ],
+      "properties": {
+        "assets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Asset"
+          }
+        }
+      }
+    },
+    "Chunk": {
+      "description": "A single file path entry in a ChunkList.",
+      "type": "object",
+      "required": [
+        "path",
+        "volume_index"
+      ],
+      "properties": {
+        "path": {
+          "description": "File path relative to the IMP root directory.",
+          "type": "string"
+        },
+        "volume_index": {
+          "type": "integer",
+          "format": "uint32",
+          "minimum": 0.0
+        }
+      }
+    },
+    "ChunkList": {
+      "description": "A list of file chunks for a single asset.",
+      "type": "object",
+      "required": [
+        "chunks"
+      ],
+      "properties": {
+        "chunks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Chunk"
+          }
+        }
+      }
+    },
+    "ImfUuid": {
+      "description": "A SMPTE IMF UUID, serialised as a bare UUID string (e.g. \"0eb3d1b9-b77b-4d3f-bbe5-7c69b15dca85\")",
+      "type": "string",
+      "format": "uuid"
+    }
+  }
+}