doipjs/src/persona.js

198 lines
4.1 KiB
JavaScript
Raw Normal View History

2023-07-03 02:39:23 -06:00
/*
Copyright 2023 Yarmo Mackenbach
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { Claim } from './claim.js'
2023-07-03 02:39:23 -06:00
/**
* A persona with identity claims
* @class
* @constructor
* @public
* @example
* const claim = Claim('https://alice.tld', '123');
* const pers = Persona('Alice', 'About Alice', [claim]);
*/
2023-07-08 00:17:13 -06:00
export class Persona {
2023-07-03 02:39:23 -06:00
/**
* @param {string} name
2024-01-27 09:57:46 -07:00
* @param {Claim[]} claims
*/
constructor (name, claims) {
/**
* Identifier of the persona
* @type {string | null}
* @public
2023-07-03 02:39:23 -06:00
*/
this.identifier = null
2023-07-03 02:39:23 -06:00
/**
* Name to be displayed on the profile page
* @type {string}
* @public
*/
2023-07-03 02:39:23 -06:00
this.name = name
/**
* Email address of the persona
* @type {string | null}
* @public
*/
this.email = null
/**
* Description to be displayed on the profile page
* @type {string | null}
* @public
*/
this.description = null
/**
* URL to an avatar image
* @type {string | null}
* @public
*/
this.avatarUrl = null
2023-10-05 03:11:25 -06:00
/**
* Theme color
* @type {string | null}
* @public
*/
this.themeColor = null
2023-07-03 02:39:23 -06:00
/**
* List of identity claims
2024-01-27 09:57:46 -07:00
* @type {Claim[]}
* @public
*/
2023-07-03 02:39:23 -06:00
this.claims = claims
/**
* Has the persona been revoked
* @type {boolean}
* @public
*/
this.isRevoked = false
}
/**
* @function
* @param {object} personaObject
* @param {number} profileVersion
* @returns {Persona | Error}
* @example
* doip.Persona.fromJSON(JSON.stringify(persona), 2);
*/
static fromJSON (personaObject, profileVersion) {
/** @type {Persona} */
let persona
let result
if (typeof personaObject === 'object' && profileVersion) {
switch (profileVersion) {
case 2:
result = importJsonPersonaVersion2(personaObject)
if (result instanceof Error) {
throw result
}
persona = result
break
default:
throw new Error('Invalid persona version')
}
}
return persona
}
/**
* @function
* @param {string} identifier
*/
setIdentifier (identifier) {
this.identifier = identifier
}
/**
* @function
* @param {string} description
*/
setDescription (description) {
this.description = description
}
/**
* @function
* @param {string} email
*/
setEmailAddress (email) {
this.email = email
}
/**
* @function
* @param {string} avatarUrl
*/
setAvatarUrl (avatarUrl) {
this.avatarUrl = avatarUrl
}
/**
* @function
2024-01-27 09:57:46 -07:00
* @param {Claim} claim
*/
addClaim (claim) {
this.claims.push(claim)
}
/**
* @function
*/
revoke () {
this.isRevoked = true
}
/**
* Get a JSON representation of the Profile object
* @function
* @returns {object}
*/
toJSON () {
return {
identifier: this.identifier,
name: this.name,
email: this.email,
description: this.description,
avatarUrl: this.avatarUrl,
2023-10-05 03:11:25 -06:00
themeColor: this.themeColor,
isRevoked: this.isRevoked,
claims: this.claims.map(x => x.toJSON())
}
2023-07-03 02:39:23 -06:00
}
}
/**
* @param {object} personaObject
* @returns {Persona | Error}
*/
function importJsonPersonaVersion2 (personaObject) {
const claims = personaObject.claims.map(x => Claim.fromJSON(x))
const persona = new Persona(personaObject.name, claims)
persona.identifier = personaObject.identifier
persona.email = personaObject.email
persona.description = personaObject.description
persona.avatarUrl = personaObject.avatarUrl
2023-10-05 03:11:25 -06:00
persona.themeColor = personaObject.avatarUrl
persona.isRevoked = personaObject.isRevoked
return persona
}