Platform Docs

SDK Platform Truthfulness - 2026-07-02

/platform/sdk-platform-truthfulness-2026-07-02

SDK Platform Truthfulness - 2026-07-02

This note is the current public-docs boundary for the Membloc WebView module SDK. It keeps Platform Alpha claims separate from the Family App MVP Beta lane.

Current Decision

  • Family App MVP Beta does not depend on third-party WebView module support.
  • membloc-sdk remains Platform Alpha until the SDK, Flutter host bridge, app-engine runtime routes, docs, and a non-legacy sample pass end-to-end QA.
  • window.membloc is the only supported namespace for new module work.
  • window.homb and window.memble are legacy/historical names only.

Source And Mirror

SurfaceRole
membloc-sdk/membloc-sdk.jsSDK source of truth
membloc-sdk/membloc-sdk.d.tsType source of truth
membloc-sdk/README.mdSDK behavior/support source of truth
membloc-docs/public/sdk/v1/Published static mirror; must match membloc-sdk source files

membloc-docs/public/sdk/v1/ is not edited as an independent API source. When SDK files change, copy the source artifacts into the mirror and verify the files match.

Support Matrix

Namespace / methodCurrent supportProduct claim
window.memblocActiveCanonical global namespace for new modules
auth.getAccessTokenPlatform AlphaModule-scoped runtime token path exists when the module is installed for the active family
data.get/set/delete/listPlatform AlphaHost bridge routes to app-engine runtime data APIs
ui.close/setTitle/showToastPlatform AlphaHost UI helper path exists
auth.getUserInfoPlaceholder AlphaHost bridge exists, but real user payload wiring is not yet stable
family.getCurrent/getMembersPlaceholder AlphaHost bridge exists, but real family/member payload wiring is not yet stable
settings.get/updateDeferredPlaceholder only; no durable runtime settings persistence
storage.*UnsupportedNo current WebView bridge route or runtime storage endpoint for this namespace
notifications.sendUnsupportedNo current WebView bridge route; engine side effect is not product-ready
activity.postUnsupportedNo current WebView bridge route; engine side effect is not product-ready
ui.showConfirm/shareToChannelUnsupportedNo current WebView bridge route
on/off eventsLocal onlyListener registry exists, but host event emission is not a stable contract

Legacy Sample Boundary

homb-module-budget-sample is legacy reference material only. It can be used to inspect React/Vite structure, but it must not be used as an onboarding sample for publisher SDK calls because it uses window.homb.

Before Platform Alpha can become a public SDK lane, create or migrate a sample that uses window.membloc, avoids unsupported APIs, and has a build/test path.

Verification Policy

  • SDK source changes: run npm test in membloc-sdk.
  • Published mirror changes: compare membloc-sdk/* against membloc-docs/public/sdk/v1/*.
  • Public docs changes: run npm run lint and npm run build in membloc-docs.
  • Sample changes: run the sample build if the sample code changes.

SDK assets

Static SDK files

JavaScript runtime and TypeScript definitions are served from this docs app.
membloc-sdk.jsmembloc-sdk.d.ts