@plasius/entity-manager


Entity definitions and validation schemas for the Plasius ecosystem.

This package is part of the Plasius LTD selective open-source strategy. For more on our approach, see ADR-0013: Selective Open Source. This package is maintained as open source to foster community trust and enable integration, while the core Plasius platform remains proprietary.

Apache-2.0. ESM + CJS builds. TypeScript types included.

---

Installation

``bash
npm install @plasius/entity-manager
`

---

Usage

`ts
import {
userEntitySchema,
PreferredDisplayOrder,
} from "@plasius/entity-manager";

const user = {
type: "userEntity",
version: "1.0",
email: "alice@example.com",
name: {
firstName: "Alice",
lastName: "Lovelace",
displayName: "Alice L.",
preferredDisplayOrder: PreferredDisplayOrder.DISPLAY_NAME,
},
};

const result = userEntitySchema.validate(user);
if (!result.valid) {
console.error(result.errors);
}
`

---

Export Overview

$3


- baseEntitySchema, baseEntityShape, BaseEntity
- Required fields include partitionKey, id, entityType, createdAt, createdBy, and isDeleted (plus system type and version).

$3

- userEntitySchema, userNameSchema, userAvatarSchema
- settingsEntitySchema, permissionsEntitySchema, featureFlagEntitySchema, roleEntitySchema
- Enums: PreferredDisplayOrder, UserEmailPreferences, UserNotificationPreferences, Role, Scope

$3

- assetEntitySchema, imageAssetEntitySchema, audioAssetEntitySchema, modelAssetEntitySchema, objectAssetEntitySchema
- Enums: AudioChannel, ModelAssetFormat

$3

- baseComponentSchema, physicsComponentSchema, animationComponentSchema, shadowComponentSchema, levelOfDetailComponentSchema
- Enum: ComponentTypes

$3

- authenticatedUserSchema, AuthProvider
- translatableSchema, supportedLanguagesSchema

$3

- isValidAzureTableKey, isValidEntityType, validateAssetSchema
- validateFeatureFlagValue, validateSettingValue`

---

Key Documentation

- Plasius Pillars
- Investor Brief
- Competition
- Architecture Decision Records (ADRs)

---

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

- Code of Conduct
- Contributor License Agreement

---

License

Licensed under the Apache-2.0 License.