WritePermitted | @m-ld/m-ld - v0.8.2

Hierarchy

OrmDomain
- WritePermitted

Implements

MeldExtensions

Index

Properties

constraints

Methods

Properties

Readonly constraints

constraints: MeldConstraint[] = [{check: this.checkPermissions,apply: this.checkPermissions}]

Methods

checkPermissions

checkPermissions(state: MeldReadState, update: InterimUpdate): Promise<void[]>

Parameters
- state: MeldReadState
- update: InterimUpdate
Returns Promise<void[]>

initialise

initialise(state: MeldReadState): Promise<void>

Parameters
- state: MeldReadState
Returns Promise<void>

onUpdate

onUpdate(update: MeldPreUpdate, state: MeldReadState): Promise<void>

Parameters
- update: MeldPreUpdate
- state: MeldReadState
Returns Promise<void>

withActiveState

withActiveState<T>(state: MeldReadState, proc: (orm: OrmState) => T | Promise<T>): Promise<T>

Inherited from OrmDomain.withActiveState

Type parameters
- T
Parameters
- state: MeldReadState
- proc: (orm: OrmState) => T | Promise<T>
  - - (orm: OrmState): T | Promise<T>
    - Parameters
      - orm: OrmState
      Returns T | Promise<T>
Returns Promise<T>

Static declare

declare(priority: number): Subject

Extension declaration. Insert into the domain data to install the extension. For example (assuming a m-ld clone object):
```
clone.write(WritePermitted.declare(0));
```
Parameters
- priority: number
  
  the preferred index into the existing list of extensions (lower value is higher priority).
Returns Subject

Static declareControlled

declareControlled(permissionIri: Iri, ...controlledShapes: (Subject | Reference)[]): Subject

Declares that some set of shapes are controlled by a write permission, that is, they cannot change without the principal being assigned this permission.

For example (assuming a m-ld clone object):
```
clone.write(Statutory.declareControlled(
  'namePermission', { '@id': 'documentStateShape' }
));
```
Parameters
- permissionIri: Iri
  
  the permission's identity (e.g. for use in declarePermission)
- Rest ...controlledShapes: (Subject | Reference)[]
  
  shape Subjects, or References to pre-existing shapes
Returns Subject

Static declarePermission

declarePermission(principalIri: Iri, permission: Reference): Subject

Declares a principal to have permission to write some shape, for example (assuming a m-ld clone object):
```
clone.write(Statutory.declarePermission(
  'https://alice.example/profile#me',
  { '@id': 'namePermission' }
));
```
Parameters
- principalIri: Iri
  
  the principal's identity. As for all domain data, this can be a relative IRI, e.g. 'fred'.
- permission: Reference
  
  the permission Reference
Returns Subject

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.8.2 Source code licensed MIT. Privacy policy