@microsoft/managed-apps-common

Shared types, utilities, and services for Managed Apps packages.

Note: This package is published internally via Azure Artifacts. It is subject to frequent breaking changes and is not intended for standalone production use outside of the Managed Apps ecosystem.

Subpaths

| Subpath | Purpose | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ./communication | JSON-RPC channel primitives, Methods.* definitions, MessagePortChannel, transfer helpers | | ./dataClient | Transport-agnostic data client (createDataClient, DataClientHost). Consumed by @microsoft/managed-apps's browser binding and the future function-runtime SDK. See docs/architecture/packages/managed-apps-common/dataClient.md | | ./errors | Structured error types | | ./gateway | Gateway path constants | | ./http | Fetch wrapper with middleware pipeline | | ./metrics | Metric type definitions | | ./services | Managed governance, region helpers, API discovery | | ./telemetry | Logger, OneDS telemetry provider | | ./testUtils | Shared mock factories | | ./types | Cross-package type definitions | | ./utils | Base64, GUID, JWT, promise, string helpers | | ./vfs | Virtual file system utilities |

Exports

Constants

• AppConfigFileName (./config) — the canonical config filename 'ms.config.json'
• AppArtifactDirName (./config) — the canonical artifact directory name '.ms'

Types

• AppMetadata, App, AppProperties, Environment - App metadata types
• AppConfig (./config) - App configuration schema type
• ClusterCategory - Cluster environment enum (Production, Test, Dev)
• ConnectionReference, RpConnection - Connection reference types
• HostError, HostErrorCode - Structured error types
• ConnectionInstance, ConnectionUsage - Connection domain types (shared with host)
• UserConsent, AuthResource - Consent domain types (shared with host)
• AppConnectionContext - Context passed to connection loading
• CdsDatabaseReference, DatasetReference, DataSourceInfo - Data source types
• Api, NestedAction, ParameterHint, ListAppPackageOperationDetails - API metadata types

Plugin Definitions

• PluginMap - Central type mapping action keys to typed function signatures
• PluginKey, PluginParams<K>, PluginResponse<K>, PluginHandler<K> - Utility types for typed plugin handlers
• PluginAction - Action name constants (derived from definition keys)
• PluginDefinition - Generic mapped type for defining plugin entries
• GetContextKey, GetCdsKey, GetAppConnectionsKey, HttpSendKey, MessagingGetVersionInfoKey, MessagingSendKey - Dot-namespaced action key constants
• PluginAliases - Legacy wire-format key to canonical key map
• IContext - Response type for AppLifecycle.getContext
• SendHttpRequest, SendHttpResponse - Types for Http.send

HTTP

• HttpClient - Fetch wrapper with interceptors, base URL, and default headers
• HttpClientOptions - Configuration for HttpClient
• HttpError - Error class for non-OK HTTP responses
• HttpRequestConfig, HttpResponse - Request/response types
• RequestInterceptor, ResponseInterceptor - Interceptor types

Telemetry

• TelemetryLogger - Logger for telemetry events
• LogLevel - Enum for log severity levels
• TelemetryEvent - Interface for telemetry event data

Utilities

• parseQueryParams(url) - Parse query parameters from a URL string
• buildUrl(base, params) - Build a URL with query parameters

Scripts

| Script | Description | | ------------- | ----------------------------- | | build | Compile TypeScript to dist/ | | dev | Watch mode compilation | | check-types | Type-check without emitting | | lint | Run ESLint on src/ | | test | Run Bun tests (src/) | | clean | Remove dist/ and .turbo/ |

Test Utilities

Shared mock factories live in src/__tests__/testUtils/:

• createMockConnection(overrides?) — returns a ConnectionInstance with sensible defaults

Import from the barrel: import { createMockConnection } from '../../__tests__/testUtils';