Mosaic Web API

@mnc/msc-module-api is the published Angular library for the Mosaic Micro-Frontend API. It exposes the shared interfaces, the MscModuleApiService, and the MscModuleApiModule that Mosaic-based frontends use to integrate with the Mosaic host application.

The workspace root contains the package metadata for the library, and the build publishes the generated package from dist/msc-module-api.

Install

npm install @mnc/msc-module-api

This package targets Angular 19 and expects the matching Angular peer dependencies to be installed in the consuming application.

Usage

Import the API types or the service directly from the package root:

import { IMscAPI, MscModuleApiService } from '@mnc/msc-module-api';

Example service usage:

constructor(private readonly mosaicApiService: MscModuleApiService) {}

setApi(api: IMscAPI): void {
  this.mosaicApiService.setMosaicAPI(api);
}

The public API surface is defined in projects/msc-module-api/src/public-api.ts. It currently exports:

• IMscAPI
• MscModuleApiService
• MscModuleApiModule
• the Mosaic API interfaces under src/lib/api/**

Build

Build the library with the Angular workspace command:

npm run build

This generates the distributable package in dist/msc-module-api.

Publish

Publish from the generated dist folder:

cd dist/msc-module-api
npm publish

If you publish to a private registry, pass the registry explicitly:

npm publish --registry <your-registry-url>

Versioning

The package version is controlled by the library metadata that is copied into dist/msc-module-api/package.json during the build. Bump the version before publishing a new release.

Notes

• Keep the README in this repository aligned with the generated package README so the npm listing matches the source docs.