@layers/amba-shared

@layers/amba-shared

Amba is the agent-native backend-as-a-service for mobile and web apps. This package is the shared TypeScript types and constants consumed by the Amba SDKs. Most application code should depend on a higher-level SDK (@layers/amba-web, @layers/amba-node, etc.) and pull types from this package only when needed.

Install

npm install @layers/amba-shared@1.0.0

What's exported

The default entry re-exports:

• Types — AppUser, Project, ApiKey, PushCampaign, Segment, RemoteConfig, ContentItem, StreakDefinition, UserEntitlement, EngagementEvent, AnalyticsOverview, ApiResponse<T>, ApiError.
• Constants — API_VERSION, DEFAULT_API_URL, CONSOLE_URL, INTEGRATION_PROVIDERS, KEY_PREFIX, SYSTEM_SEGMENTS, XP_PER_LEVEL.
• Validators — isValidProjectSlug, isValidIanaTimezone, isReservedCollectionName, isReservedBindingName, validateRateLimitConfig.
• Domain modules — gamification, social, economy, platform.

Subpath imports are available for direct access: @layers/amba-shared/platform-types, /social-types, /economy-types, /gamification-types, /referral-codes, /reserved-collection-prefixes.

Docs

Full reference: https://docs.amba.dev/sdk/shared.

License

Apache-2.0