@meddleware/docs 0.0.1

package/docs/walrus-storage/api/type-aliases/UploadOptions.md

@@ -0,0 +1,37 @@
+# Type Alias: UploadOptions
+
+> **UploadOptions** = `object`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:27
+
+Options shared by all upload helpers.
+
+## Properties
+
+### deletable?
+
+> `optional` **deletable?**: `boolean`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:31
+
+Whether the blob can be deleted by its owner (default false).
+
+***
+
+### epochs?
+
+> `optional` **epochs?**: `number`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:29
+
+Storage epochs to reserve (default: MAX\_SINGLE\_RESERVATION\_EPOCHS).
+
+***
+
+### tags?
+
+> `optional` **tags?**: `Record`\<`string`, `string`\>
+
+Defined in: @meddleware/walrus-client/src/upload.ts:33
+
+Arbitrary key-value metadata tags stored with the blob.

package/docs/walrus-storage/api/type-aliases/UploadResult.md

@@ -0,0 +1,27 @@
+# Type Alias: UploadResult
+
+> **UploadResult** = `object`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:37
+
+The object IDs returned after a successful upload.
+
+## Properties
+
+### blobId
+
+> **blobId**: `string`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:39
+
+Walrus content-addressed blob ID.
+
+***
+
+### blobObjectId
+
+> **blobObjectId**: `string`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:41
+
+On-chain Walrus blob object ID.

package/docs/walrus-storage/api/type-aliases/WalrusClient.md

@@ -0,0 +1,7 @@
+# Type Alias: WalrusClient
+
+> **WalrusClient** = `ReturnType`\<*typeof* [`createWalrusClient`](../functions/createWalrusClient.md)\>
+
+Defined in: @meddleware/walrus-client/src/upload.ts:6
+
+The return type of [createWalrusClient](../functions/createWalrusClient.md).

package/docs/walrus-storage/api/type-aliases/WalrusNetwork.md

@@ -0,0 +1,7 @@
+# Type Alias: WalrusNetwork
+
+> **WalrusNetwork** = `"testnet"` \| `"mainnet"`
+
+Defined in: @meddleware/walrus-client/src/client.ts:9
+
+Supported Walrus network environments.

package/docs/walrus-storage/api/typedoc-sidebar.json

@@ -0,0 +1 @@
+[{"text":"Classes","collapsed":true,"items":[{"text":"RetryableWalrusClientError","link":"/docs/walrus-storage/api/classes/RetryableWalrusClientError.md"},{"text":"WalrusFile","link":"/docs/walrus-storage/api/classes/WalrusFile.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CertifyOptions","link":"/docs/walrus-storage/api/interfaces/CertifyOptions.md"},{"text":"StorageCost","link":"/docs/walrus-storage/api/interfaces/StorageCost.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AccessProofInput","link":"/docs/walrus-storage/api/type-aliases/AccessProofInput.md"},{"text":"CreateWalrusClientOptions","link":"/docs/walrus-storage/api/type-aliases/CreateWalrusClientOptions.md"},{"text":"ExtendOptions","link":"/docs/walrus-storage/api/type-aliases/ExtendOptions.md"},{"text":"OwnedBlob","link":"/docs/walrus-storage/api/type-aliases/OwnedBlob.md"},{"text":"PersonalMessageSigner","link":"/docs/walrus-storage/api/type-aliases/PersonalMessageSigner.md"},{"text":"RelayChallenge","link":"/docs/walrus-storage/api/type-aliases/RelayChallenge.md"},{"text":"UploadOptions","link":"/docs/walrus-storage/api/type-aliases/UploadOptions.md"},{"text":"UploadResult","link":"/docs/walrus-storage/api/type-aliases/UploadResult.md"},{"text":"WalrusClient","link":"/docs/walrus-storage/api/type-aliases/WalrusClient.md"},{"text":"WalrusNetwork","link":"/docs/walrus-storage/api/type-aliases/WalrusNetwork.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"DEFAULT_RPC_URLS","link":"/docs/walrus-storage/api/variables/DEFAULT_RPC_URLS.md"},{"text":"LONG_TERM_EPOCHS","link":"/docs/walrus-storage/api/variables/LONG_TERM_EPOCHS.md"},{"text":"MAINNET_WALRUS_PACKAGE_CONFIG","link":"/docs/walrus-storage/api/variables/MAINNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"PUBLIC_UPLOAD_RELAY_HOSTS","link":"/docs/walrus-storage/api/variables/PUBLIC_UPLOAD_RELAY_HOSTS.md"},{"text":"TESTNET_WALRUS_PACKAGE_CONFIG","link":"/docs/walrus-storage/api/variables/TESTNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"WALRUS_AGGREGATOR_HOSTS","link":"/docs/walrus-storage/api/variables/WALRUS_AGGREGATOR_HOSTS.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProofToken","link":"/docs/walrus-storage/api/functions/buildAccessProofToken.md"},{"text":"certifyBlobTransaction","link":"/docs/walrus-storage/api/functions/certifyBlobTransaction.md"},{"text":"createBlobUploadFlow","link":"/docs/walrus-storage/api/functions/createBlobUploadFlow.md"},{"text":"createRelayAccessToken","link":"/docs/walrus-storage/api/functions/createRelayAccessToken.md"},{"text":"createUploadFlow","link":"/docs/walrus-storage/api/functions/createUploadFlow.md"},{"text":"createWalrusClient","link":"/docs/walrus-storage/api/functions/createWalrusClient.md"},{"text":"estimateStorageCost","link":"/docs/walrus-storage/api/functions/estimateStorageCost.md"},{"text":"extendBlobLifetime","link":"/docs/walrus-storage/api/functions/extendBlobLifetime.md"},{"text":"extendBlobLifetimeTransaction","link":"/docs/walrus-storage/api/functions/extendBlobLifetimeTransaction.md"},{"text":"fetchOwnedWalrusBlobs","link":"/docs/walrus-storage/api/functions/fetchOwnedWalrusBlobs.md"},{"text":"fetchRelayChallenge","link":"/docs/walrus-storage/api/functions/fetchRelayChallenge.md"},{"text":"getWalrusPackageConfig","link":"/docs/walrus-storage/api/functions/getWalrusPackageConfig.md"},{"text":"personalMessageForNonce","link":"/docs/walrus-storage/api/functions/personalMessageForNonce.md"},{"text":"readBlobAttributes","link":"/docs/walrus-storage/api/functions/readBlobAttributes.md"},{"text":"setBlobAttributes","link":"/docs/walrus-storage/api/functions/setBlobAttributes.md"},{"text":"setBlobAttributesTransaction","link":"/docs/walrus-storage/api/functions/setBlobAttributesTransaction.md"},{"text":"uploadBytes","link":"/docs/walrus-storage/api/functions/uploadBytes.md"},{"text":"uploadImageBytes","link":"/docs/walrus-storage/api/functions/uploadImageBytes.md"},{"text":"uploadLocalFile","link":"/docs/walrus-storage/api/functions/uploadLocalFile.md"},{"text":"walrusBlobUrl","link":"/docs/walrus-storage/api/functions/walrusBlobUrl.md"}]}]

package/docs/walrus-storage/api/variables/DEFAULT_RPC_URLS.md

@@ -0,0 +1,7 @@
+# Variable: DEFAULT\_RPC\_URLS
+
+> `const` **DEFAULT\_RPC\_URLS**: `Record`\<[`WalrusNetwork`](../type-aliases/WalrusNetwork.md), `string`\>
+
+Defined in: @meddleware/walrus-client/src/client.ts:18
+
+Default Sui full-node RPC URLs, keyed by network.

package/docs/walrus-storage/api/variables/LONG_TERM_EPOCHS.md

@@ -0,0 +1,12 @@
+# Variable: LONG\_TERM\_EPOCHS
+
+> `const` **LONG\_TERM\_EPOCHS**: `200` = `200`
+
+Defined in: @meddleware/walrus-client/src/upload.ts:24
+
+Recommended TARGET lifetime for critical assets (~7.7 years at a ~2-week epoch
+cadence). NOTE: this cannot be reached in one reservation — it exceeds
+MAX\_SINGLE\_RESERVATION\_EPOCHS. Reaching it requires periodic renewal via
+[extendBlobLifetime](../functions/extendBlobLifetime.md) before expiry. When passing this as an initial
+`epochs` value, clamp to `MAX_SINGLE_RESERVATION_EPOCHS` first, or pass an
+explicit `epochs <= 53`.

package/docs/walrus-storage/api/variables/MAINNET_WALRUS_PACKAGE_CONFIG.md

@@ -0,0 +1,15 @@
+# Variable: MAINNET\_WALRUS\_PACKAGE\_CONFIG
+
+> `const` **MAINNET\_WALRUS\_PACKAGE\_CONFIG**: `object`
+
+Defined in: @meddleware/walrus-client/node\_modules/@mysten/walrus/dist/constants.d.mts:9
+
+## Type Declaration
+
+### stakingPoolId
+
+> **stakingPoolId**: `string`
+
+### systemObjectId
+
+> **systemObjectId**: `string`

package/docs/walrus-storage/api/variables/PUBLIC_UPLOAD_RELAY_HOSTS.md

@@ -0,0 +1,10 @@
+# Variable: PUBLIC\_UPLOAD\_RELAY\_HOSTS
+
+> `const` **PUBLIC\_UPLOAD\_RELAY\_HOSTS**: `Record`\<[`WalrusNetwork`](../type-aliases/WalrusNetwork.md), `string`\>
+
+Defined in: @meddleware/walrus-client/src/client.ts:29
+
+Public Mysten-operated upload relays. Used as the default when no `uploadRelayHost`
+is specified. An upload relay is REQUIRED for browser uploads — direct-to-storage-node
+writes fail from browsers and constrained networks. Operators who run their own relay
+should pass `uploadRelayHost` to `createWalrusClient` instead.

package/docs/walrus-storage/api/variables/TESTNET_WALRUS_PACKAGE_CONFIG.md

@@ -0,0 +1,19 @@
+# Variable: TESTNET\_WALRUS\_PACKAGE\_CONFIG
+
+> `const` **TESTNET\_WALRUS\_PACKAGE\_CONFIG**: `object`
+
+Defined in: @meddleware/walrus-client/node\_modules/@mysten/walrus/dist/constants.d.mts:4
+
+## Type Declaration
+
+### exchangeIds
+
+> **exchangeIds**: `string`[]
+
+### stakingPoolId
+
+> **stakingPoolId**: `string`
+
+### systemObjectId
+
+> **systemObjectId**: `string`

package/docs/walrus-storage/api/variables/WALRUS_AGGREGATOR_HOSTS.md

@@ -0,0 +1,7 @@
+# Variable: WALRUS\_AGGREGATOR\_HOSTS
+
+> `const` **WALRUS\_AGGREGATOR\_HOSTS**: `Record`\<[`WalrusNetwork`](../type-aliases/WalrusNetwork.md), `string`\>
+
+Defined in: @meddleware/walrus-client/src/client.ts:35
+
+Public Walrus aggregators (serve raw blob bytes at `/v1/blobs/<blobId>`).

package/docs/walrus-storage/index.md

@@ -0,0 +1,54 @@
+# Walrus Storage
+
+Upload files to [Walrus](https://walrus.xyz) — decentralised "blob" storage on Sui — and manage how
+long they live. Open the app at [sui-walrus.meddleware.co.uk](https://sui-walrus.meddleware.co.uk).
+
+## What it is
+
+Walrus stores arbitrary files (called **blobs**) across a decentralised network, with the metadata and
+lifetime tracked on Sui. The Meddleware Walrus Storage app is a thin front-end for it: connect a
+wallet, upload a file, get back a **blob ID**, and later list and extend the blobs you own.
+
+## When to use it
+
+- You need **durable, decentralised** file storage addressable by a stable ID.
+- You're storing content for an app, NFT media, datasets, or documents.
+- You want to store **encrypted** content — pair it with [Sealed Storage](/sealed-storage/), which
+  uses Walrus underneath.
+
+When **not** to: Walrus is not a permanent free drive. Storage is paid and **time-bounded** (see
+below), and blobs are public unless you encrypt them first.
+
+## The one thing to understand: blobs expire
+
+::: warning Walrus storage is time-bounded
+A blob is stored for a number of **epochs** (Walrus's unit of time), not forever. When the paid
+period ends, the blob can be deleted by the network. If you need to keep something, **extend its
+lifetime before it expires** — the app's *My Blobs* view lets you do this.
+:::
+
+Roughly: more epochs = longer storage = higher up-front cost. The app shows you the cost before you
+confirm, and long-term durations are supported for content you intend to keep.
+
+## Public vs gated uploads (relays)
+
+Browser uploads go through an **upload relay**. Two modes:
+
+- **Public relay** — the default fallback (Mysten's public relay). Works for anyone.
+- **Gated relay** — Meddleware's relay, gated by an [Access Gate](/access-gate/) NFT. You prove you
+  hold a valid pass and the relay accepts your upload. A small **tip** covers the relay's costs, and
+  the app caps the tip so you never overpay.
+
+If you don't hold a pass, uploads simply use the public relay. Either way, the blob ends up on the
+same Walrus network.
+
+## What you get back
+
+After an upload completes you receive a **blob ID** — the stable handle you use to read the content
+back (via a Walrus aggregator) or to reference it elsewhere. See [Reference](/walrus-storage/reference)
+for the exact shapes.
+
+## Next
+
+- **[Using it](/walrus-storage/using)** — upload, view, and extend blobs step by step.
+- **[Reference](/walrus-storage/reference)** — blob/relay shapes and the SDK API.

package/docs/walrus-storage/reference.md

@@ -0,0 +1,69 @@
+# Walrus Storage — reference
+
+Shapes and identifiers behind the Walrus Storage app. Conceptual here; the **exhaustive, always-current
+API** is auto-generated from the `@meddleware/walrus-client` SDK — see [SDK API](#sdk-api).
+
+## Blob lifetime
+
+Walrus measures storage in **epochs**. The client exposes protocol-bounded constants (e.g. a
+long-term default and a maximum single reservation) that reflect Walrus's `max_epochs_ahead`. You
+choose a duration at upload time and can extend later; extension must happen **before** expiry.
+
+## Upload result
+
+An upload returns a stable **blob ID** plus registration details. Conceptually:
+
+```ts
+interface UploadResult {
+  blobId: string          // stable handle used to read the blob back
+  // …registration/certification details (see generated SDK API for exact fields)
+}
+```
+
+## Owned blob
+
+*My Blobs* lists the blobs your address owns:
+
+```ts
+interface OwnedBlob {
+  blobId: string
+  // …end epoch / size / object id (see generated SDK API for exact fields)
+}
+```
+
+## Storage cost estimate
+
+Before confirming, the app estimates cost from the chosen duration:
+
+```ts
+interface StorageCost {
+  // …storage + write cost in MIST (see generated SDK API for exact fields)
+}
+```
+
+## Gated relay: access-proof wire format
+
+When uploading through the **gated** relay, the client proves NFT ownership with a signed proof. The
+wire format is shared with the [Access Gate](/access-gate/) gateway:
+
+- **Personal message signed by the wallet:** `nft-gate:access:<nonce>`
+- **Proof token** (sent as `Authorization: Bearer …`): base64 of
+
+```json
+{ "address": "0x…", "nonce": "…", "signature": "…", "consumeDigest": "…" }
+```
+
+The relay verifies the signature and on-chain pass ownership, then accepts the upload. See the
+[Access Gate reference](/access-gate/reference) for the full protocol.
+
+## SDK API
+
+The full `@meddleware/walrus-client` API — client factory, upload flows, lifetime management, owned-blob
+queries, and relay access helpers — is generated here:
+
+- [Walrus client API](./api/)
+
+::: tip Using the SDK in your own app?
+This reference lists the shapes; the **how-to** for integrating the SDK (and self-hosting a relay) is
+`dev.meddleware.co.uk` material, planned in the package's own docs.
+:::

package/docs/walrus-storage/using.md

@@ -0,0 +1,53 @@
+# Walrus Storage — using it
+
+A walkthrough of the [Walrus Storage app](https://sui-walrus.meddleware.co.uk). You'll need a
+[Sui wallet with a little SUI](/getting-started).
+
+## Upload a blob
+
+1. **Connect** your wallet (header).
+2. Go to the **Upload** tab and **choose a file**.
+3. Pick a **storage duration** (in epochs). The app estimates the cost — longer durations cost more
+   up front.
+4. If you hold an [Access Gate](/access-gate/) pass for the gated relay, the app detects it and uses
+   the gated relay (a capped **tip** applies); otherwise it uses the public relay.
+5. **Confirm** the transaction(s) in your wallet. Uploading registers the blob on Sui and stores the
+   bytes on Walrus.
+6. When it finishes you get a **blob ID** — copy it. That's how you (or anyone) reads the content back.
+
+::: tip Interrupted upload?
+The gated flow is designed so an interrupted or retried upload **doesn't waste** a single-use pass —
+the app remembers the in-progress redemption and resumes it rather than consuming another use.
+:::
+
+## View your blobs
+
+Open **My Blobs**. The app lists the Walrus blobs your address owns, with their IDs and remaining
+lifetime. This reads on-chain ownership directly — no extra login.
+
+## Extend a blob's lifetime
+
+Because blobs expire, *My Blobs* lets you **extend** one before it lapses:
+
+1. Find the blob in **My Blobs**.
+2. Choose **Extend** and pick how many additional epochs.
+3. Confirm the transaction. The blob's stored-until point moves out accordingly.
+
+Do this **before** expiry — once a blob has lapsed and been removed, it can't be extended, only
+re-uploaded.
+
+## Read a blob back
+
+A blob ID resolves through a Walrus **aggregator** over plain HTTP. Anyone with the ID can fetch the
+bytes (blobs are public unless you encrypted them first with [Sealed Storage](/sealed-storage/)).
+
+## Common questions
+
+**Is my file private?** No — Walrus blobs are public. If you need privacy, use
+[Sealed Storage](/sealed-storage/), which encrypts before storing.
+
+**Why did I sign more than once?** Registering and storing can involve more than one step; the app
+guides you through each wallet prompt.
+
+**What does the tip do?** On the gated relay, the tip covers the relay's operating cost. The app
+requests the minimum and caps it so you can't overpay.

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@meddleware/docs",
+  "version": "0.0.1",
+  "description": "Meddleware user documentation site (docs.meddleware.co.uk) — VitePress. Explains the DAO, Walrus Storage, Sealed Storage, and Access Gate: what each is, how to use it, and when.",
+  "author": "Meddleware <dev@meddleware.co.uk>",
+  "license": "0BSD",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meddleware-org/docs.git"
+  },
+  "type": "module",
+  "files": [
+    "docs",
+    "scripts",
+    "tsconfig.json",
+    "tsconfig.typedoc.json",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "gen:api": "node scripts/gen-api.mjs",
+    "dev": "npm run gen:api && vitepress dev docs",
+    "build": "npm run gen:api && vitepress build docs",
+    "preview": "vitepress preview docs",
+    "type-check": "tsc --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@meddleware/design-tokens": "^0.1.2"
+  },
+  "devDependencies": {
+    "@meddleware/nft-gate-client": "^0.0.6",
+    "@meddleware/seal-client": "^0.0.3",
+    "@meddleware/walrus-client": "^0.0.11",
+    "@mysten/seal": "^1.4.7",
+    "@mysten/sui": "^2.30.0",
+    "@mysten/walrus": "^0.7.0",
+    "@types/node": "~24.12.2",
+    "typedoc": "^0.28.0",
+    "typedoc-plugin-markdown": "^4.4.0",
+    "typedoc-vitepress-theme": "^1.1.0",
+    "typescript": "~6.0.0",
+    "vitepress": "^1.6.3",
+    "vue": "^3.5.40"
+  },
+  "engines": {
+    "node": "^22.18.0 || >=24.12.0"
+  }
+}

package/scripts/gen-api.mjs

@@ -0,0 +1,107 @@
+// Autodoc step for the docs site (Part C of the docs plan).
+//
+// Generates Markdown API reference from the published Meddleware TypeScript SDKs using TypeDoc +
+// typedoc-plugin-markdown, writing into each service's `api/` subtree (git-ignored, built fresh).
+// The service `reference.md` pages link into these.
+//
+// Design goals:
+//  - Exhaustive: point TypeDoc at each SDK's full public entry so nothing is hand-maintained.
+//  - Resilient: a missing/unresolvable package warns and writes a placeholder instead of failing
+//    the whole docs build. An empty result is a signal to fix the SDK's `types`/`exports`, not to
+//    paper over here — CI logs make that visible.
+import { createRequire } from 'node:module'
+import { execFileSync } from 'node:child_process'
+import { mkdirSync, writeFileSync, existsSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import { dirname, resolve, join } from 'node:path'
+
+const require = createRequire(import.meta.url)
+const root = resolve(dirname(fileURLToPath(import.meta.url)), '..')
+const docsRoot = join(root, 'docs')
+
+// Each SDK → where its generated reference lands under docs/.
+const targets = [
+  { pkg: '@meddleware/walrus-client', out: 'walrus-storage/api', name: 'Walrus client API' },
+  { pkg: '@meddleware/seal-client', out: 'sealed-storage/api', name: 'Seal client API' },
+  { pkg: '@meddleware/nft-gate-client', out: 'access-gate/api', name: 'NFT-gate client API' },
+]
+
+// Resolve the SDK's TypeScript entry. These packages export their `.` as `./src/index.ts`
+// (string-form exports) but restrict `./package.json`, so resolve the package entry directly
+// rather than via its package.json. Fall back to a manual src/index.ts probe if needed.
+function resolveEntry(pkg) {
+  try {
+    // `.` export → src/index.ts for the Meddleware SDKs.
+    return require.resolve(pkg)
+  } catch {
+    // Fallback: locate the installed package dir without relying on an exported package.json.
+    try {
+      const dir = join(root, 'node_modules', ...pkg.split('/'))
+      for (const candidate of ['src/index.ts', 'index.ts', 'dist/index.d.ts']) {
+        const p = join(dir, candidate)
+        if (existsSync(p)) return p
+      }
+    } catch {
+      /* ignore */
+    }
+    return null
+  }
+}
+
+function typedocBin() {
+  const bin = join(root, 'node_modules', '.bin', process.platform === 'win32' ? 'typedoc.cmd' : 'typedoc')
+  return existsSync(bin) ? bin : null
+}
+
+let failures = 0
+for (const { pkg, out, name } of targets) {
+  const outDir = join(docsRoot, out)
+  mkdirSync(outDir, { recursive: true })
+
+  const entry = resolveEntry(pkg)
+  const bin = typedocBin()
+  if (!entry || !bin) {
+    failures++
+    const why = !entry ? `could not resolve ${pkg}` : 'typedoc binary not found'
+    console.warn(`[gen:api] ${name}: ${why} — writing placeholder.`)
+    writeFileSync(
+      join(outDir, 'index.md'),
+      `# ${name}\n\n::: warning Reference not generated\nAutodoc could not run for \`${pkg}\` (${why}). ` +
+        `Ensure the package is installed and exposes its TypeScript \`src\`/types, then rebuild.\n:::\n`,
+    )
+    continue
+  }
+
+  try {
+    execFileSync(
+      bin,
+      [
+        entry,
+        '--plugin', 'typedoc-plugin-markdown',
+        '--plugin', 'typedoc-vitepress-theme',
+        '--out', outDir,
+        '--readme', 'none',
+        '--githubPages', 'false',
+        '--hideBreadcrumbs', 'true',
+        '--tsconfig', join(root, 'tsconfig.typedoc.json'),
+        '--skipErrorChecking',
+        '--name', name,
+      ],
+      { stdio: 'inherit', cwd: root },
+    )
+    console.log(`[gen:api] ${name}: generated → docs/${out}`)
+  } catch (e) {
+    failures++
+    console.warn(`[gen:api] ${name}: TypeDoc failed — writing placeholder. ${e?.message ?? e}`)
+    writeFileSync(
+      join(outDir, 'index.md'),
+      `# ${name}\n\n::: warning Reference not generated\nTypeDoc failed for \`${pkg}\`. See build logs.\n:::\n`,
+    )
+  }
+}
+
+if (failures) {
+  console.warn(`[gen:api] completed with ${failures} placeholder(s); site still builds.`)
+} else {
+  console.log('[gen:api] all SDK references generated.')
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "types": ["node"]
+  },
+  "include": ["docs/.vitepress", "scripts"]
+}

package/tsconfig.typedoc.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "types": []
+  },
+  "//": "Used only by scripts/gen-api.mjs (TypeDoc). Includes the installed SDK sources so the TS program has inputs; TypeDoc's entryPoints then select what is documented.",
+  "include": [
+    "node_modules/@meddleware/seal-client/src",
+    "node_modules/@meddleware/walrus-client/src",
+    "node_modules/@meddleware/nft-gate-client/src"
+  ]
+}