Skip to main content

Manifest Building

Creating application manifests with the Node.js SDK.

Overview​

The manifest declares your application's:

  • Metadata (ID, name, version)
  • Dependencies
  • Permissions
  • UI components
  • Docker containers
  • Settings schema
  • Event subscriptions

Basic Manifest​

TODO: Add basic manifest example

{
  id: 'my-app',
  name: 'My Application',
  version: '1.0.0',
  description: 'A sample application',
  author: 'Your Name',
  license: 'MIT'
}

Dependencies​

TODO: Document dependency declaration:

HARD Dependencies​

dependencies: {
  hard: [
    {
      appId: 'auth-service',
      version: '>=2.0.0 <3.0.0'
    }
  ]
}

SOFT Dependencies​

dependencies: {
  soft: [
    {
      appId: 'analytics',
      version: '>=1.0.0'
    }
  ]
}

Permissions​

TODO: Document permission declaration

UI Components​

TODO: Document UI component declaration for microfrontends

Docker Containers​

TODO: Document Docker container declaration

Settings Schema​

TODO: Document settings schema with JSON Schema

Event Subscriptions​

TODO: Document event subscription declaration

Manifest Validation​

TODO: Document manifest validation

Type Safety​

The SDK provides TypeScript types for manifests:

import type { AppManifest } from '@easy/appserver-sdk';