Struct TenantScopePlugin 

pub struct TenantScopePlugin { /* private fields */ }

Implementations

impl TenantScopePlugin

pub fn new() -> Self

pub fn from_manifest(manifest: &AppManifest) -> Self

Auto-configure from a manifest: any entity that declares a tenantId (or tenant_id) field is marked tenant-scoped using that field.

This is how the server registers the plugin by default. Adding a tenantId field to an entity is the signal — no separate config step required. Apps that use a different field name (e.g. orgId) can still call [scope_with_field] after this to customize.

pub fn scope(&mut self, entity: impl Into<String>) -> &mut Self

Mark entity as tenant-scoped using the default tenantId field.

pub fn scope_with_field( &mut self, entity: impl Into<String>, field: impl Into<String>, ) -> &mut Self

Mark entity as tenant-scoped using a custom field name.

pub fn is_scoped(&self, entity: &str) -> bool

pub fn field_for(&self, entity: &str) -> Option<&str>

pub fn stamp_insert( &self, entity: &str, data: &mut Value, auth: &AuthContext, ) -> Result<(), TenantError>

Stamp tenantId onto a row that’s about to be inserted. Returns Err if the entity is scoped but the caller has no tenant.

pub fn check_write( &self, entity: &str, existing: &Value, auth: &AuthContext, ) -> Result<(), TenantError>

Verify that an existing row belongs to the caller’s tenant before allowing a mutation.

Trait Implementations

impl Default for TenantScopePlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for TenantScopePlugin

fn name(&self) -> &str

Unique name for this plugin.

fn on_init(&self, _ctx: &PluginContext)

Called once when the plugin is registered.

fn routes(&self) -> Vec<PluginRoute>

Custom API routes this plugin handles.

fn before_insert( &self, _entity: &str, _data: &mut Value, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity insert. Return Err to reject.

fn after_insert( &self, _entity: &str, _id: &str, _data: &Value, _auth: &AuthContext, )

Called after a successful insert.

fn before_update( &self, _entity: &str, _id: &str, _data: &mut Value, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity update. Return Err to reject.

fn after_update( &self, _entity: &str, _id: &str, _data: &Value, _auth: &AuthContext, )

Called after a successful update.

fn before_delete( &self, _entity: &str, _id: &str, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity delete. Return Err to reject.

fn after_delete(&self, _entity: &str, _id: &str, _auth: &AuthContext)

Called after a successful delete.

fn on_request( &self, _method: &str, _path: &str, _auth: &AuthContext, ) -> Result<(), PluginError>

Called on every incoming request (middleware).

fn on_request_with_meta( &self, method: &str, path: &str, auth: &AuthContext, _meta: &RequestMeta<'_>, ) -> Result<(), PluginError>

Richer variant of [on_request] that also receives per-request metadata (peer IP today; more fields may be added later). The default implementation delegates to on_request so existing plugins keep working without changes. Plugins that care about IP — notably rate limiting — override this hook.

fn on_session_create(&self, _user_id: &str, _token: &str)

Called when a new session is created.

fn entities(&self) -> Vec<ManifestEntity>

Additional manifest entities this plugin contributes.