@opengov/psp-contract

@opengov/psp-contract

Shared contract for PSP micro-frontend modules — types, constants, and helpers.

Overview

This package is the single source of truth for the interfaces that define how remote micro-frontend modules integrate with the Public Service Platform (PSP) shell. Instead of copy-pasting type definitions, remote teams import them directly from this package.

Installation

bun add @opengov/psp-contract

Usage

import type { MountableApp, ModuleMountOptions } from '@opengov/psp-contract';

export default {
  mount(container: HTMLElement, options: ModuleMountOptions) {
    // options includes: baseRouterPath, auth0Config, activeEntity,
    // hostingEnvironment, registryConfig
  },
  unmount() {
    // Clean up
  },
} satisfies MountableApp;

Exported Types

Core Mount Contract

Type	Description
MountableApp	Interface remote modules must implement (mount/unmount)
ModuleMountOptions	Options passed to mount() by the PSP shell
Auth0Config	Auth0 configuration passed to remote modules
EntityBase	Base entity fields (id, friendlyId, name, etc.)
HostingEnvironment	Enum: DEVELOPMENT, INTEGRATION, STAGING, PRODUCTION

Resolver and Context Types

Type	Description
PspUserInfo	User info (email, sub, name) passed to modules
AppRegistryCallbackContext	Context provided to module URL resolvers
ModuleUrlResolver	Function type for resolving module URLs

Development

This package lives in the PSP monorepo at packages/psp-contract/.

# Build the package
bun run build:types

# Or from within the package directory
cd packages/psp-contract && bun run build

The PSP shell re-exports these types via src/types.ts, so existing internal imports (from '@/types') continue to work unchanged.