Class ACL

Hierarchy

CreateDestroyStartStop
- ACL

Constructors

constructor

new ACL(__namedParameters): ACL
Parameters
- __namedParameters: {
  db: DB;
  logger: Logger;
  }
  - db: DB
  - logger: Logger
Returns ACL
Inherited from CreateDestroyStartStop.constructor
- Defined in src/acl/ACL.ts:73

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` aclDbPath

aclDbPath: readonly (string | Buffer)[] = ...

`Protected` aclNodesDbPath

aclNodesDbPath: readonly (string | Buffer)[] = ...

Nodes stores NodeId -> PermissionId

`Protected` aclPermsDbPath

aclPermsDbPath: readonly (string | Buffer)[] = ...

Perms stores PermissionId -> Ref

`Protected` aclVaultsDbPath

aclVaultsDbPath: readonly (string | Buffer)[] = ...

Vaults stores VaultIdString -> Record<NodeId, null> note that the NodeId in each record must be in their own unique gestalt the NodeId in each record may be missing if it had been previously deleted

`Protected` db

db: DB

`Protected` generatePermId

generatePermId: (() => PermissionId)

Type declaration

- (): PermissionId
- Returns PermissionId

`Protected` logger

logger: Logger

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/acl/ACL.ts:96

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getNodePerm

getNodePerm(nodeId, tran?): Promise<undefined | Permission>
Gets the permission record for a given node id Any node id is acceptable
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<undefined | Permission>
- Defined in src/acl/ACL.ts:224

getNodePerms

getNodePerms(tran?): Promise<Record<NodeId, Permission>[]>
Parameters
- Optional tran: DBTransaction
Returns Promise<Record<NodeId, Permission>[]>
- Defined in src/acl/ACL.ts:129

getVaultPerm

getVaultPerm(vaultId, tran?): Promise<Record<NodeId, Permission>>
Gets the record of node ids to permission for a given vault id The node ids in the record each represent a unique gestalt If there are no permissions, then an empty record is returned
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<Record<NodeId, Permission>>
- Defined in src/acl/ACL.ts:251

getVaultPerms

getVaultPerms(tran?): Promise<Record<VaultId, Record<NodeId, Permission>>>
Parameters
- Optional tran: DBTransaction
Returns Promise<Record<VaultId, Record<NodeId, Permission>>>
- Defined in src/acl/ACL.ts:170

joinNodePerm

joinNodePerm(nodeId, nodeIdsJoin, perm?, tran?): Promise<void>
Parameters
- nodeId: NodeId
- nodeIdsJoin: NodeId[]
- Optional perm: Permission
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:632

joinVaultPerms

joinVaultPerms(vaultId, vaultIdsJoin, tran?): Promise<void>
Parameters
- vaultId: VaultId
- vaultIdsJoin: VaultId[]
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:689

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

sameNodePerm

sameNodePerm(nodeId1, nodeId2, tran?): Promise<boolean>
Parameters
- nodeId1: NodeId
- nodeId2: NodeId
- Optional tran: DBTransaction
Returns Promise<boolean>
- Defined in src/acl/ACL.ts:102

setNodeAction

setNodeAction(nodeId, action, tran?): Promise<void>
Parameters
- nodeId: NodeId
- action: "claim" | "notify" | "scan"
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:306

setNodePerm

setNodePerm(nodeId, perm, tran?): Promise<void>
Parameters
- nodeId: NodeId
- perm: Permission
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:520

setNodesPerm

setNodesPerm(nodeIds, perm, tran?): Promise<void>
Sets an array of node ids to a new permission record This is intended for completely new gestalts Or for gestalt splitting.
Parameters
- nodeIds: NodeId[]
- perm: Permission
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:465

setVaultAction

setVaultAction(vaultId, nodeId, action, tran?): Promise<void>
Parameters
- vaultId: VaultId
- nodeId: NodeId
- action: "clone" | "pull"
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:378

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/acl/ACL.ts:78

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/acl/ACL.ts:91

unsetNodeAction

unsetNodeAction(nodeId, action, tran?): Promise<void>
Parameters
- nodeId: NodeId
- action: "claim" | "notify" | "scan"
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:352

unsetNodePerm

unsetNodePerm(nodeId, tran?): Promise<void>
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:562

unsetVaultAction

unsetVaultAction(vaultId, nodeId, action, tran?): Promise<void>
Parameters
- vaultId: VaultId
- nodeId: NodeId
- action: "clone" | "pull"
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:422

unsetVaultPerms

unsetVaultPerms(vaultId, tran?): Promise<void>
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/acl/ACL.ts:594

`Static` createACL

createACL(__namedParameters): Promise<ACL>
Parameters
- __namedParameters: {
      db: DB;
      fresh?: boolean;
      logger?: Logger;
  }
  - db: DB
  - Optional fresh?: boolean
  - Optional logger?: Logger
Returns Promise<ACL>
- Defined in src/acl/ACL.ts:36

Class ACL

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; logger: Logger; }

db: DB

logger: Logger

Returns ACL

Properties

Readonly [initLock]

Protected aclDbPath

Protected aclNodesDbPath

Protected aclPermsDbPath

Protected aclVaultsDbPath

Protected db

Protected generatePermId

Type declaration

Returns PermissionId

Protected logger

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

getNodePerm

Parameters

nodeId: NodeId

Optional tran: DBTransaction

Returns Promise<undefined | Permission>

getNodePerms

Parameters

Optional tran: DBTransaction

Returns Promise<Record<NodeId, Permission>[]>

getVaultPerm

Parameters

vaultId: VaultId

Optional tran: DBTransaction

Returns Promise<Record<NodeId, Permission>>

getVaultPerms

Parameters

Optional tran: DBTransaction

Returns Promise<Record<VaultId, Record<NodeId, Permission>>>

joinNodePerm

Parameters

nodeId: NodeId

nodeIdsJoin: NodeId[]

__namedParameters: {
db: DB;
logger: Logger;
}

`Readonly` [initLock]

`Protected` aclDbPath

`Protected` aclNodesDbPath

`Protected` aclPermsDbPath

`Protected` aclVaultsDbPath

`Protected` db

`Protected` generatePermId

`Protected` logger

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` perm: Permission

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` options: boolean | EventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

__namedParameters: {
fresh?: boolean;
} = {}

`Optional` fresh?: boolean

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction