Skip to content

OS-1668: Rename island and toolkit APIs to Mentra Engine#3411

Merged
aisraelov merged 3 commits into
devfrom
philippe/os-1668-publish-the-toolkit-on-npm-as-mentraengine
Jul 11, 2026
Merged

OS-1668: Rename island and toolkit APIs to Mentra Engine#3411
aisraelov merged 3 commits into
devfrom
philippe/os-1668-publish-the-toolkit-on-npm-as-mentraengine

Conversation

@PhilippeFerreiraDeSousa

@PhilippeFerreiraDeSousa PhilippeFerreiraDeSousa commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • rename the package from @mentra/island to @mentra/engine
  • move the workspace package from mobile/modules/island to mobile/modules/engine, including the engine.ts implementation entry
  • rename the public namespace from toolkit to engine, including engine.* consumers, EngineSubmitReportInput, and useEngineSnapshot
  • rename the OEM engine documentation pages and update product terminology while leaving the separate Dev Toolkit, OEM UI Toolkit, and display-toolkit utilities unchanged
  • update workspace locks, Metro/TypeScript/Jest configuration, boundary scripts, CI workflows, examples, and historical package references

Why

The library is intended to be published and consumed as Mentra Engine. The repository still used both the internal island package name and the older toolkit API/product name across its build, test, documentation, and consumer surfaces.

Impact

Consumers must import the package and namespace as:

import {engine} from "@mentra/engine"

engine.configure(options)
await engine.start()

Runtime behavior is unchanged. This is a breaking naming change that makes package resolution, the public API, local builds, CI, documentation, and the OEM example consistently use Mentra Engine.

Validation

  • bun x tsc --noEmit -p tsconfig.json in mobile/modules/engine
  • bun run compile in mobile
  • bun run build in mobile/modules/engine
  • bun test src in mobile/modules/engine (220 passing)
  • representative mobile Jest engine mock test (5 passing)
  • ./scripts/check-mobile-runtime-boundary.sh
  • npm pack --dry-run in mobile/modules/engine
  • verified the built declarations export engine and EngineSubmitReportInput
  • verified remaining toolkit terms belong only to separate Dev/UI/display toolkits
  • git diff --check

Note

Medium Risk
Wide breaking rename across mobile, SDK, CI, and docs; low logic risk if validation passed, but every consumer must update package and engine namespace imports.

Overview
Breaking rename of the OEM integration runtime from @mentra/island / toolkit to @mentra/engine / engine: workspace path mobile/modules/islandmobile/modules/engine, public entry engine.ts, and consumers use import { engine } from "@mentra/engine" with engine.configure() / engine.start() and related types (e.g. EngineSubmitReportInput, useEngineSnapshot).

CI OEM workflows now watch and build mobile/modules/engine/**, forbid @mentra/engine/internal in the example OEM app, and describe the reference host as built against the public @mentra/engine entry. Agent specs and cloud-v2 docs are updated so product language says Mentra Engine / engine.* instead of toolkit / @mentra/island (separate Dev/UI “toolkit” products are left as-is).

No runtime behavior change—this is naming and wiring consistency for publish/consumption as Mentra Engine.

Reviewed by Cursor Bugbot for commit d2f354a. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions

github-actions Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

📋 PR Review Helper

📱 Mobile App Build

Ready to test! (commit d2f354a)

📥 Download APK

🕶️ ASG Client Build

Waiting for build...


🔀 Test Locally

gh pr checkout 3411

@github-actions

github-actions Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

PR Agent Orchestrator State

{
  "cycle": 4,
  "fixRound": 0,
  "totalReviewerRuns": 4,
  "consecutiveNoNewReviews": 4,
  "openFindings": [],
  "resolvedFindings": [],
  "nitFindings": [],
  "phase": "discovery",
  "status": "in_progress",
  "lastPair": [],
  "stagnationFixRounds": 0,
  "lastOpenCount": 0,
  "fingerprintReopenCounts": {},
  "mutedFingerprints": []
}

@github-actions

github-actions Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

🤖 PR Agent Review — cycle 4

✅ No blocking findings · 0 blocking · 0 nits
Reviewers this cycle: none

No model reviews ran this cycle.

Updated automatically by the PR Agent Orchestrator each review cycle. Nits do not block merge.

@PhilippeFerreiraDeSousa PhilippeFerreiraDeSousa changed the title OS-1668: Rename @mentra/island to @mentra/engine OS-1668: Rename island and toolkit APIs to Mentra Engine Jul 11, 2026
@PhilippeFerreiraDeSousa PhilippeFerreiraDeSousa marked this pull request as ready for review July 11, 2026 03:22
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 11, 2026

Copy link
Copy Markdown

Deploying mentra-live-ota-site with  Cloudflare Pages  Cloudflare Pages

Latest commit: d2f354a
Status: ✅  Deploy successful!
Preview URL: https://ace25a8c.mentra-live-ota-site.pages.dev
Branch Preview URL: https://philippe-os-1668-publish-the.mentra-live-ota-site.pages.dev

View logs

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying mentra-store-dev with  Cloudflare Pages  Cloudflare Pages

Latest commit: d2f354a
Status: ✅  Deploy successful!
Preview URL: https://a21e6e9f.augmentos-appstore-2.pages.dev
Branch Preview URL: https://philippe-os-1668-publish-the.augmentos-appstore-2.pages.dev

View logs

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying dev-augmentos-console with  Cloudflare Pages  Cloudflare Pages

Latest commit: d2f354a
Status: ✅  Deploy successful!
Preview URL: https://a09a2407.dev-augmentos-console.pages.dev
Branch Preview URL: https://philippe-os-1668-publish-the.dev-augmentos-console.pages.dev

View logs

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying prod-augmentos-account with  Cloudflare Pages  Cloudflare Pages

Latest commit: d2f354a
Status: ✅  Deploy successful!
Preview URL: https://68eb8792.augmentos-e84.pages.dev
Branch Preview URL: https://philippe-os-1668-publish-the.augmentos-e84.pages.dev

View logs

@aisraelov aisraelov merged commit 66cbe9f into dev Jul 11, 2026
32 checks passed
aisraelov added a commit that referenced this pull request Jul 11, 2026
Dev's #3411 renamed @mentra/island to @mentra/engine (toolkit → engine)
across every file this branch deletes or edits. Resolution re-expresses
the ripout in the engine world:

- Files this branch deletes (host SocketComms/WSM/RestComms/ws-types,
  BackendUrl, NonProdWarning, and the module RestComms): deletion wins;
  dev's only changes to them were the mechanical rename.
- Content conflicts: this branch's version plus dev's exact rename sweep
  (@mentra/island → @mentra/engine, toolkit → engine, useToolkitSnapshot
  → useEngineSnapshot), with comment wording aligned to dev's engine
  naming.

tsc clean on the merged tree (mobile src + modules).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants