@blockcast/mmt-wasm 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,48 @@
-# Temporary Holding Version
+# @blockcast/mmt-wasm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The libmmt Rust core (RaptorQ FEC, MMTP MFU reassembly) as wasm-bindgen output,
+in the two shapes its consumers need:
+
+| Entry point | Form | Consumer |
+| --- | --- | --- |
+| `@blockcast/mmt-wasm` | ES module (`--target web`) | hang's `js/watch` |
+| `@blockcast/mmt-wasm/no-modules` | global script (`--target no-modules`) | pim's Shaka page, whose Closure build cannot take an ES module |
+
+Each wrapper ships with the `.wasm` from its own out-dir and loads it as a
+sibling, so both are also exported by path for callers that need the URL:
+
+```js
+// ESM
+import init, { MmtFecDecoder } from "@blockcast/mmt-wasm"
+await init()
+
+// Global script: serve pkg-no-modules/ and load the wrapper with a <script>
+// tag, then hand wasm_bindgen the URL its .wasm is served from.
+await wasm_bindgen("/vendor/mmt-wasm/mmt_wasm_bg.wasm")
+const decoder = new wasm_bindgen.MmtFecDecoder(/* ... */)
+```
+
+Called with no argument, the global wrapper derives the URL from its own
+`<script src>` by replacing `.js` with `_bg.wasm` — so serving the two files
+side by side works without passing anything.
+
+## Building
+
+`pkg/` and `pkg-no-modules/` are generated and **never committed** — they are
+gitignored, and `make check-source-artifacts` fails if either is ever tracked.
+Produce them with the canonical target, which builds both and stages them here:
+
+```sh
+BLOCKCAST_MMT_WASM_BUILD_ROOT=/tmp/blockcast-mmt-wasm make mmt-wasm
+```
+
+The build root must live outside the repository. `make stage-mmt-wasm` re-stages
+from an existing build root without rebuilding.
+
+`npm test` runs the build contract: it packs the package, asserts every
+`exports` target and both wrapper/`.wasm` pairs are in the tarball, and
+instantiates both forms from a scratch install. Run it after `make mmt-wasm`;
+with nothing staged it fails, which is the intended signal. `make clean`
+unstages both directories to get back to that state — they are gitignored, so
+nothing else removes them and the contract would otherwise keep validating
+whatever was staged last.

package/package.json

@@ -1,6 +1,40 @@
 {
-  "name": "@blockcast/mmt-wasm",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@blockcast/mmt-wasm",
+	"version": "0.1.0",
+	"description": "wasm-bindgen builds of the libmmt Rust core (RaptorQ FEC, MMTP MFU reassembly): `pkg` for ESM bundlers and `pkg-no-modules` as a global script for Closure-compiled pages",
+	"main": "pkg/mmt_wasm.js",
+	"types": "pkg/mmt_wasm.d.ts",
+	"exports": {
+		".": {
+			"types": "./pkg/mmt_wasm.d.ts",
+			"import": "./pkg/mmt_wasm.js"
+		},
+		"./mmt_wasm_bg.wasm": "./pkg/mmt_wasm_bg.wasm",
+		"./no-modules": {
+			"types": "./pkg-no-modules/mmt_wasm.d.ts",
+			"default": "./pkg-no-modules/mmt_wasm.js"
+		},
+		"./no-modules/mmt_wasm_bg.wasm": "./pkg-no-modules/mmt_wasm_bg.wasm",
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"pkg",
+		"pkg-no-modules"
+	],
+	"scripts": {
+		"build": "make -C ../.. mmt-wasm",
+		"test": "node build-contract.test.mjs"
+	},
+	"keywords": [
+		"mmt",
+		"mmtp",
+		"raptorq",
+		"wasm"
+	],
+	"license": "Apache-2.0",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Blockcast/libmmt.git",
+		"directory": "packages/mmt-wasm"
+	}
+}