Class default`Abstract`

Application of CertificateRoleModel for relation certificates.

Hierarchy (View Summary)

default
- default

Constructors

constructor

new default(
    leuteModel: default,
    roleApp: string,
    roleRelation: string,
    config?: {
        filterSharedWith?: (personId: SHA256IdHash<Person>) => boolean;
        propagateRolePersonCertificatesToOthers?: boolean;
        propagateRolePersonInstancesToOthers?: boolean;
        roleGroupName?: string;
        trusted?: boolean | ((personId: SHA256IdHash<Person>) => boolean);
    } & RoleConfig & RelationRoleConfig,
): default
Constructor for the RelationRoleModel
Parameters
- leuteModel: default
  The leute model
- roleApp: string
  The app of the role
- roleRelation: string
  The relation of the role
- Optionalconfig: {
      filterSharedWith?: (personId: SHA256IdHash<Person>) => boolean;
      propagateRolePersonCertificatesToOthers?: boolean;
      propagateRolePersonInstancesToOthers?: boolean;
      roleGroupName?: string;
      trusted?: boolean | ((personId: SHA256IdHash<Person>) => boolean);
  } & RoleConfig & RelationRoleConfig
  The config of the role
Returns default
Overrides default.constructor
- Defined in models/role/RelationRoleModel.ts:46

Properties

onFound

onFound: OEvent<() => void | Promise<void>> = ...

onInitialised

onInitialised: OEvent<() => void | Promise<void>> = ...

state

state: StateMachine<"Uninitialised" | "Initialised", "shutdown" | "init">

`Static`roleName

roleName: string

Methods

canCreate

canCreate(role: string | StaticRoleModel<default>): boolean | Promise<boolean>
Checks if the role can be created.
Parameters
- role: string | StaticRoleModel<default>
  The role name or static role class to check.
Returns boolean | Promise<boolean>
True if the role can be created, false otherwise.
Inherited from default.canCreate
- Defined in models/role/Role.ts:187

createCertificate

createCertificate(
    personId: SHA256IdHash<Person>,
    issuerId?: SHA256IdHash<Person>,
): Promise<
    {
        certificate: UnversionedObjectResult<RelationCertificate>;
        license: UnversionedObjectResult<License>;
        signature: UnversionedObjectResult<Signature>;
    },
>
Create a certificate
Parameters
- personId: SHA256IdHash<Person>
  The person Id
- OptionalissuerId: SHA256IdHash<Person>
  The issuer id
Returns Promise<
    {
        certificate: UnversionedObjectResult<RelationCertificate>;
        license: UnversionedObjectResult<License>;
        signature: UnversionedObjectResult<Signature>;
    },
>
The certificate
Overrides default.createCertificate
- Defined in models/role/RelationRoleModel.ts:163

getCertificates

getCertificates(
personId: SHA256IdHash<Person>,
): Promise<CertificateData<RelationCertificate>[]>
Get the certificates for a person
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<CertificateData<RelationCertificate>[]>
The certificates
Overrides default.getCertificates
- Defined in models/role/RelationRoleModel.ts:98

getIssuerPersonIdFromRoleCertificate

getIssuerPersonIdFromRoleCertificate(
data: OneObjectTypes,
): Promise<undefined | SHA256IdHash<Person>>
Get the issuer person id from the role certificate
Parameters
- data: OneObjectTypes
  The role certificate
Returns Promise<undefined | SHA256IdHash<Person>>
The issuer person id
- Defined in models/role/RelationRoleModel.ts:214

getIssuerPersonIdsFromRoleCertificate

getIssuerPersonIdsFromRoleCertificate(
rolePersonId: SHA256IdHash<Person>,
): Promise<SHA256IdHash<Person>[]>
Get the issuer person ids from the role certificate
Parameters
- rolePersonId: SHA256IdHash<Person>
  The role person id
Returns Promise<SHA256IdHash<Person>[]>
The issuer person ids
Overrides default.getIssuerPersonIdsFromRoleCertificate
- Defined in models/role/RelationRoleModel.ts:83

getIssuers

getIssuers(): Promise<default[]>
************* Semi-abstracts **************

Returns Promise<default[]>
Inherited from default.getIssuers
- Defined in models/role/Role.ts:44

getPersonIdFromRoleCertificate

getPersonIdFromRoleCertificate(
data: OneObjectTypes,
): Promise<undefined | SHA256IdHash<Person>>
Get the person id from the role certificate
Parameters
- data: OneObjectTypes
  The role certificate
Returns Promise<undefined | SHA256IdHash<Person>>
The person id
Overrides default.getPersonIdFromRoleCertificate
- Defined in models/role/RelationRoleModel.ts:59

getRoleName

getRoleName(): string
Returns the name of the role.

Returns string
The name of the role.
Inherited from default.getRoleName
- Defined in models/role/Role.ts:119

getRolePersonIds

getRolePersonIds(): Promise<SHA256IdHash<Person>[]>
Returns the role person ids.

Returns Promise<SHA256IdHash<Person>[]>
The role person ids.
Inherited from default.getRolePersonIds
- Defined in models/role/CertificateRoleModel.ts:132

getSignatureHashes

getSignatureHashes(
personId: SHA256IdHash<Person>,
): Promise<undefined | SHA256Hash[]>
Get the signature hash for a person
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<undefined | SHA256Hash[]>
The signature hash
Inherited from default.getSignatureHashes
- Defined in models/role/CertificateRoleModel.ts:225

hasAffirmed

hasAffirmed(
data: SHA256Hash | SHA256IdHash,
byPersonId?: SHA256IdHash<Person>,
): Promise<boolean>
Checks if the data is affirmed by the role person ids.
Parameters
- data: SHA256Hash | SHA256IdHash
  The data to check.
- OptionalbyPersonId: SHA256IdHash<Person>
  The personId that should be trusting the data.
Returns Promise<boolean>
True if the data is affirmed, false otherwise.
Inherited from default.hasAffirmed
- Defined in models/role/Role.ts:129

hasCertificate

hasCertificate(personId: SHA256IdHash<Person>): Promise<boolean>
Check if the person has a certificate
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<boolean>
True if the person has a certificate, false otherwise
Inherited from default.hasCertificate
- Defined in models/role/CertificateRoleModel.ts:238

hasMultipleCertificates

hasMultipleCertificates(personId: SHA256IdHash<Person>): Promise<boolean>
Check if the person has multiple certificates
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<boolean>
True if the person has multiple certificates, false otherwise
Inherited from default.hasMultipleCertificates
- Defined in models/role/CertificateRoleModel.ts:247

hasSigned

hasSigned(data: SHA256Hash, byPersonId?: SHA256IdHash<Person>): Promise<boolean>
Checks if the data is signed by the role person ids.
Parameters
- data: SHA256Hash
  The data to check.
- OptionalbyPersonId: SHA256IdHash<Person>
  The personId that should be signing the data.
Returns Promise<boolean>
True if the data is signed, false otherwise.
Inherited from default.hasSigned
- Defined in models/role/Role.ts:160

init

init(): Promise<void>
Initializes the CertificateRoleModel.

Returns Promise<void>
Inherited from default.init
- Defined in models/role/CertificateRoleModel.ts:106

isInitialised

isInitialised(): boolean
Returns true if the role is initialised.

Returns boolean
True if the role is initialised, false otherwise.
Inherited from default.isInitialised
- Defined in models/role/Role.ts:111

isIssuer

isIssuer(personId: SHA256IdHash<Person>): Promise<boolean>
Check if the person is an issuer
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<boolean>
True if the person is an issuer or no issuers are set, false otherwise
Inherited from default.isIssuer
- Defined in models/role/CertificateRoleModel.ts:185

isRoleCertificate

isRoleCertificate(
data: OneObjectTypes,
rolePersonId?: SHA256IdHash<Person>,
): Promise<boolean>
Check if the certificate is a role relation certificate
Parameters
- data: OneObjectTypes
  The certificate
- OptionalrolePersonId: SHA256IdHash<Person>
  The role person id
Returns Promise<boolean>
True if the certificate is a role relation certificate, false otherwise
- Defined in models/role/RelationRoleModel.ts:121

isRolePerson

isRolePerson(personId?: SHA256IdHash<Person>): Promise<boolean>
Checks if the person is a role person.
Parameters
- OptionalpersonId: SHA256IdHash<Person>
  The personId to check. Default is the current person.
Returns Promise<boolean>
True if the person is a role person, false otherwise.
Inherited from default.isRolePerson
- Defined in models/role/CertificateRoleModel.ts:147

setRolePerson

setRolePerson(
personId: SHA256IdHash<Person>,
issuerPersonId?: SHA256IdHash<Person>,
): Promise<void>
Set the role person
Parameters
- personId: SHA256IdHash<Person>
  The person id
- OptionalissuerPersonId: SHA256IdHash<Person>
  The issuer person id
Returns Promise<void>
Inherited from default.setRolePerson
- Defined in models/role/CertificateRoleModel.ts:256

shareIssuers

shareIssuers(
rolePersonId: SHA256IdHash<Person>,
shareWithPersonIds: SHA256IdHash<Person>[],
): Promise<void>
Share the issuers with the person ids
Parameters
- rolePersonId: SHA256IdHash<Person>
  The role person id
- shareWithPersonIds: SHA256IdHash<Person>[]
  The person ids to share with
Returns Promise<void>
Inherited from default.shareIssuers
- Defined in models/role/CertificateRoleModel.ts:203

shareWith

shareWith(
shareWithPersonIds: SHA256IdHash<Person>[],
options?: { forcePropagate?: boolean; rolePersonId?: SHA256IdHash<Person> },
): Promise<void>
Shares the role with the given person ids.
Parameters
- shareWithPersonIds: SHA256IdHash<Person>[]
  The person ids to share with.
- options: { forcePropagate?: boolean; rolePersonId?: SHA256IdHash<Person> } = {}
  - OptionalforcePropagate?: boolean
    Whether to force the role person id from options.rolePersonId to propagate. Default is false.
  - OptionalrolePersonId?: SHA256IdHash<Person>
    The role person id. Default is the current person.
Returns Promise<void>
Inherited from default.shareWith
- Defined in models/role/CertificateRoleModel.ts:157

shutdown

shutdown(): Promise<void>
Shuts down the CertificateRoleModel.

Returns Promise<void>
Inherited from default.shutdown
- Defined in models/role/CertificateRoleModel.ts:116

Class defaultAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

onFound

onInitialised

state

StaticroleName

Methods

canCreate

Parameters

Returns boolean | Promise<boolean>

createCertificate

Parameters

Returns Promise< { certificate: UnversionedObjectResult<RelationCertificate>; license: UnversionedObjectResult<License>; signature: UnversionedObjectResult<Signature>; },>

getCertificates

Parameters

Returns Promise<CertificateData<RelationCertificate>[]>

getIssuerPersonIdFromRoleCertificate

Parameters

Returns Promise<undefined | SHA256IdHash<Person>>

getIssuerPersonIdsFromRoleCertificate

Parameters

Returns Promise<SHA256IdHash<Person>[]>

getIssuers

Returns Promise<default[]>

getPersonIdFromRoleCertificate

Parameters

Returns Promise<undefined | SHA256IdHash<Person>>

getRoleName

Returns string

getRolePersonIds

Returns Promise<SHA256IdHash<Person>[]>

getSignatureHashes

Parameters

Returns Promise<undefined | SHA256Hash[]>

hasAffirmed

Parameters

Returns Promise<boolean>

hasCertificate

Parameters

Returns Promise<boolean>

hasMultipleCertificates

Parameters

Returns Promise<boolean>

hasSigned

Parameters

Returns Promise<boolean>

init

Returns Promise<void>

isInitialised

Returns boolean

isIssuer

Parameters

Returns Promise<boolean>

isRoleCertificate

Parameters

Returns Promise<boolean>

isRolePerson

Parameters

Returns Promise<boolean>

setRolePerson

Parameters

Returns Promise<void>

shareIssuers

Parameters

Returns Promise<void>

shareWith

Parameters

OptionalforcePropagate?: boolean

OptionalrolePersonId?: SHA256IdHash<Person>

Returns Promise<void>

shutdown

Class default`Abstract`

`Static`roleName

Returns Promise<
{
certificate: UnversionedObjectResult<RelationCertificate>;
license: UnversionedObjectResult<License>;
signature: UnversionedObjectResult<Signature>;
},
>

`Optional`forcePropagate?: boolean

`Optional`rolePersonId?: SHA256IdHash<Person>