Add `plugin-setup` to own the platform Setup App by Copilot · Pull Request #998 · objectstack-ai/objectstack

Copilot · 2026-03-31T02:28:46Z

Setup App definition (identity, areas, navigation merge) had no clear owner — scattered between spec and objectql. This adds @objectstack/plugin-setup as a first-class internal plugin (sibling to plugin-auth, plugin-security, plugin-audit) that owns the Setup App lifecycle.

New package: `packages/plugins/plugin-setup`

Setup Areas (setup-areas.ts): Four built-in area skeletons — Administration, Platform, System, AI — with i18n labels, icons, and sort order. Empty by default.
Setup App (setup-app.ts): App identity (name, label, icon, branding, setup.access permission). SetupNavContribution type for the contribution API.
SetupPlugin (setup-plugin.ts):
- init → registers setupNav service
- start → merges contributions into area skeletons, filters empties, registers finalized app via app.com.objectstack.setup service convention
20 tests covering area constants, app defaults, plugin lifecycle, contribution merging, ordering, custom areas, immutability of constants.

Extension model

// Any plugin can contribute to Setup during init:
async init(ctx: PluginContext) {
  const setupNav = ctx.getService<SetupNavService>('setupNav');
  setupNav.contribute({
    areaId: SETUP_AREA_IDS.administration,
    items: [
      { id: 'nav_users', type: 'object', label: 'Users', objectName: 'sys_user' },
    ],
  });
}

Housekeeping

Added @objectstack/plugin-setup to .changeset/config.json fixed group
Updated CHANGELOG.md and ROADMAP.md

vercel · 2026-03-31T02:28:52Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
objectstack-play	Ready	Preview, Comment	Mar 31, 2026 2:38am
spec	Ready	Preview, Comment	Mar 31, 2026 2:38am

…vigation composition Agent-Logs-Url: https://github.com/objectstack-ai/spec/sessions/2d62f7a2-3d90-476d-aaa9-178b76bf9517 Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot

Pull request overview

Introduces @objectstack/plugin-setup as the owning implementation for the platform “Setup App”, providing a first-class plugin extension point (setupNav) for other plugins to contribute Setup navigation areas/items.

Changes:

Added new internal plugin package packages/plugins/plugin-setup (Setup app defaults, built-in areas, contribution service, merge/finalization logic, tests, docs).
Added @objectstack/plugin-setup to the Changesets fixed group.
Updated repository documentation/trackers (root CHANGELOG.md, ROADMAP.md) to reflect the new plugin.

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
ROADMAP.md	Marks Setup App ownership as delivered by `@objectstack/plugin-setup`.
pnpm-lock.yaml	Adds lockfile entries for the new workspace package.
.changeset/config.json	Adds `@objectstack/plugin-setup` to the fixed version group.
CHANGELOG.md	Notes the new plugin in the repo-level Unreleased changelog.
packages/plugins/plugin-setup/package.json	New plugin package definition, build/test scripts, exports.
packages/plugins/plugin-setup/tsconfig.json	TS config for building plugin sources.
packages/plugins/plugin-setup/src/setup-areas.ts	Defines built-in Setup area skeletons + well-known area IDs.
packages/plugins/plugin-setup/src/setup-app.ts	Defines Setup App defaults + contribution type.
packages/plugins/plugin-setup/src/setup-plugin.ts	Implements `setupNav` service and area merge/finalization logic.
packages/plugins/plugin-setup/src/setup-plugin.test.ts	Unit tests for constants and plugin lifecycle/merging behavior.
packages/plugins/plugin-setup/src/index.ts	Public exports for plugin + constants/types.
packages/plugins/plugin-setup/README.md	Documents usage and extension model for contributions.
packages/plugins/plugin-setup/objectstack.config.ts	Adds plugin manifest/config for the package.
packages/plugins/plugin-setup/CHANGELOG.md	Adds a package-level changelog entry for the new plugin.

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Copilot · 2026-03-31T03:01:11Z

+  async start(ctx: PluginContext): Promise<void> {
+    ctx.logger.info('Starting Setup Plugin — finalizing Setup App...');
+
+    // Merge contributions into area skeletons.
+    const areas = this.mergeAreas(this.contributions);
+
+    // Build the final Setup App.
+    const setupApp: App = {
+      ...SETUP_APP_DEFAULTS,
+      areas: areas.length > 0 ? areas : undefined,
+    };
+
+    // Register the finalized Setup App as an internal platform app
+    // following the `app.<id>` service convention used by ObjectQLPlugin.
+    ctx.registerService('app.com.objectstack.setup', {
+      id: 'com.objectstack.setup',
+      name: 'Setup',
+      version: '1.0.0',
+      type: 'plugin',


app.com.objectstack.setup is registered in start(), but ObjectQLPlugin only discovers app.* services once during its own start() (it scans ctx.getServices() there). If ObjectQLPlugin starts before SetupPlugin, the Setup App service won't be discovered/registered, and the app may never appear. To make registration order-independent, register the app manifest earlier (during init) or explicitly register the manifest with the ObjectQL engine service after finalizing (e.g. via ctx.getService('objectql').registerApp(...)) instead of relying solely on app.* discovery timing.

Copilot · 2026-03-31T03:01:12Z

+# @objectstack/plugin-setup
+
+## 3.3.1
+
+### Added
+
+- Initial release of the Setup Plugin.
+- Defines the platform Setup App identity (name, label, icon, permissions, branding).
+- Ships 4 built-in Setup Areas: Administration, Platform, System, AI.
+- Provides `setupNav` service for contribution-based navigation composition.
+- Auto-filters empty areas and supports custom area extensions.


This package changelog format diverges from the repo’s Changesets-generated package CHANGELOGs (e.g. other plugins use the standard "Patch/Minor Changes" sections and dependency bump lines). Since release automation uses Changesets (pnpm run version / changeset version), this file is likely to be overwritten or become inconsistent. Consider generating/maintaining it via Changesets (and/or aligning the format with other packages/plugins/*/CHANGELOG.md files).

Copilot · 2026-03-31T03:01:12Z

+export const SETUP_APP_DEFAULTS: Omit<App, 'areas'> & { areas: NavigationArea[] } = {
+  name: 'setup',
+  label: {
+    key: 'setup.app.label',
+    defaultValue: 'Setup',
+  },
+  description: {
+    key: 'setup.app.description',
+    defaultValue: 'Platform settings and administration',
+  },
+  icon: 'settings',
+  active: true,
+  isDefault: false,
+  branding: {
+    primaryColor: '#475569', // Slate-600 — neutral admin palette
+  },
+  requiredPermissions: ['setup.access'],
+  areas: [],
+};


SETUP_APP_DEFAULTS is typed as always having areas, but SetupPlugin conditionally sets areas to undefined at runtime when there are no contributions. Using the stricter { areas: NavigationArea[] } type here can mislead consumers into assuming areas is always present. Consider typing SETUP_APP_DEFAULTS as App (or Omit<App, 'areas'> & { areas?: NavigationArea[] }) to match the actual runtime shape.

Initial plan

777d1df

Copilot AI assigned Copilot and hotlong Mar 31, 2026

Copilot started work on behalf of hotlong March 31, 2026 02:28

View session

Copilot AI linked an issue Mar 31, 2026 that may be closed by this pull request

[Proposal] Create plugin-setup to own and finalize the platform Setup App #997

Closed

vercel Bot deployed to Preview – spec March 31, 2026 02:31

View deployment

vercel Bot deployed to Preview – objectstack-play March 31, 2026 02:31

View deployment

feat: add plugin-setup — Platform Setup App plugin with area-based na…

6fffcda

…vigation composition Agent-Logs-Url: https://github.com/objectstack-ai/spec/sessions/2d62f7a2-3d90-476d-aaa9-178b76bf9517 Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview – spec March 31, 2026 02:38

View deployment

vercel Bot deployed to Preview – objectstack-play March 31, 2026 02:38

View deployment

Copilot AI changed the title ~~[WIP] Add plugin-setup to own and register the platform Setup App~~ Add plugin-setup to own the platform Setup App Mar 31, 2026

Copilot finished work on behalf of hotlong March 31, 2026 02:42

Copilot AI requested a review from hotlong March 31, 2026 02:42

hotlong marked this pull request as ready for review March 31, 2026 02:52

Copilot AI review requested due to automatic review settings March 31, 2026 02:52

Copilot started reviewing on behalf of hotlong March 31, 2026 02:53

View session

hotlong merged commit cc52e5c into main Mar 31, 2026
5 checks passed

Copilot AI reviewed Mar 31, 2026

View reviewed changes

Navigation Menu

Repository navigation

Add `plugin-setup` to own the platform Setup App - #998

Add `plugin-setup` to own the platform Setup App#998
hotlong merged 2 commits into
mainfrom
copilot/add-plugin-setup-for-platform-app

Copilot AI commented Mar 31, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Mar 31, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New package: packages/plugins/plugin-setup

Extension model

Housekeeping

Uh oh!

vercel Bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Mar 31, 2026 •

edited

Loading

New package: `packages/plugins/plugin-setup`

vercel Bot commented Mar 31, 2026 •

edited

Loading