@meith/profile-fields 0.16.0

package/LICENSE.md

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@meith/profile-fields",
+  "version": "0.16.0",
+  "license": "LGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meith-dev/meith.git",
+    "directory": "packages/profile-fields"
+  },
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "files": [
+    "src",
+    "!src/**/*.test.*",
+    "!src/**/*.type-test.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@meith/core": "0.16.0",
+    "@meith/i18n": "0.16.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,19 @@
+export {
+  editableFields,
+  type FieldAccess,
+  maxLengthFor,
+  resolveAccess,
+  visibleFields,
+} from './resolve'
+export { type ProfileFieldContext, ProfileFieldService } from './service'
+export {
+  DEFAULT_MAX_LENGTH,
+  FIELD_TYPES,
+  type FieldType,
+  type ProfileFieldDefinition,
+  type ProfileFieldGroupRule,
+  type ProfileFieldRepository,
+  type ProfileFieldValue,
+  parseFieldType,
+  type ResolvedProfileField,
+} from './types'

package/src/resolve.ts

@@ -0,0 +1,70 @@
+import {
+  DEFAULT_MAX_LENGTH,
+  type ProfileFieldDefinition,
+  type ProfileFieldGroupRule,
+  type ResolvedProfileField,
+} from './types'
+
+export interface FieldAccess {
+  readonly canView: boolean
+  readonly canEdit: boolean
+}
+
+export function resolveAccess(
+  field: ProfileFieldDefinition,
+  applicable: readonly ProfileFieldGroupRule[],
+): FieldAccess {
+  const mine = applicable.filter((rule) => rule.fieldId === field.id)
+
+  return {
+    canView: combine(
+      mine.map((rule) => rule.canView),
+      field.defaultVisible,
+    ),
+    canEdit: combine(
+      mine.map((rule) => rule.canEdit),
+      field.defaultEditable,
+    ),
+  }
+}
+
+function combine(answers: readonly (boolean | null)[], fallback: boolean): boolean {
+  const stated = answers.filter((answer): answer is boolean => answer !== null)
+  if (stated.length === 0) return fallback
+  return stated.some((answer) => answer)
+}
+
+export function visibleFields(input: {
+  readonly fields: readonly ProfileFieldDefinition[]
+  readonly applicable: readonly ProfileFieldGroupRule[]
+  readonly values: ReadonlyMap<number, string>
+}): readonly ResolvedProfileField[] {
+  return input.fields
+    .filter((field) => field.isActive)
+    .map((field) => ({
+      field,
+      value: input.values.get(field.id) ?? '',
+      ...resolveAccess(field, input.applicable),
+    }))
+    .filter((resolved) => resolved.canView && resolved.value !== '')
+}
+
+export function editableFields(input: {
+  readonly fields: readonly ProfileFieldDefinition[]
+  readonly applicable: readonly ProfileFieldGroupRule[]
+  readonly values: ReadonlyMap<number, string>
+}): readonly ResolvedProfileField[] {
+  return input.fields
+    .filter((field) => field.isActive)
+    .map((field) => ({
+      field,
+      value: input.values.get(field.id) ?? '',
+      ...resolveAccess(field, input.applicable),
+    }))
+    .filter((resolved) => resolved.canEdit)
+}
+
+export function maxLengthFor(field: ProfileFieldDefinition): number {
+  if (field.maxLength !== null && field.maxLength > 0) return field.maxLength
+  return field.type === null ? DEFAULT_MAX_LENGTH.text : DEFAULT_MAX_LENGTH[field.type]
+}

package/src/service.ts

@@ -0,0 +1,224 @@
+import { ValidationError } from '@meith/core'
+import { msg } from '@meith/i18n'
+
+import { editableFields, maxLengthFor, visibleFields } from './resolve'
+import type {
+  ProfileFieldDefinition,
+  ProfileFieldGroupRule,
+  ProfileFieldRepository,
+  ProfileFieldValue,
+  ResolvedProfileField,
+} from './types'
+
+export interface ProfileFieldContext {
+  readonly applicable: readonly ProfileFieldGroupRule[]
+}
+
+export class ProfileFieldService {
+  private readonly repository: ProfileFieldRepository
+
+  constructor(deps: { fields: ProfileFieldRepository }) {
+    this.repository = deps.fields
+  }
+
+  async listAll(): Promise<readonly ProfileFieldDefinition[]> {
+    return this.repository.listFields()
+  }
+
+  async listGroupRules(): Promise<readonly ProfileFieldGroupRule[]> {
+    return this.repository.listGroupRules()
+  }
+
+  async visibleFor(
+    userId: number,
+    context: ProfileFieldContext,
+  ): Promise<readonly ResolvedProfileField[]> {
+    const [fields, values] = await Promise.all([
+      this.repository.listFields(),
+      this.repository.valuesFor(userId),
+    ])
+
+    return visibleFields({
+      fields,
+      applicable: context.applicable,
+      values: byField(values),
+    })
+  }
+
+  async editableFor(
+    userId: number,
+    context: ProfileFieldContext,
+  ): Promise<readonly ResolvedProfileField[]> {
+    const [fields, values] = await Promise.all([
+      this.repository.listFields(),
+      this.repository.valuesFor(userId),
+    ])
+
+    return editableFields({
+      fields,
+      applicable: context.applicable,
+      values: byField(values),
+    })
+  }
+
+  async requiredAtRegistration(
+    context: ProfileFieldContext,
+  ): Promise<readonly ProfileFieldDefinition[]> {
+    const fields = await this.repository.listFields()
+
+    return editableFields({
+      fields,
+      applicable: context.applicable,
+      values: new Map(),
+    })
+      .filter((resolved) => resolved.field.requiredAtRegistration)
+      .map((resolved) => resolved.field)
+  }
+
+  async save(input: {
+    readonly userId: number
+    readonly submitted: ReadonlyMap<string, string>
+    readonly context: ProfileFieldContext
+  }): Promise<void> {
+    const editable = await this.editableFor(input.userId, input.context)
+
+    const values: ProfileFieldValue[] = []
+    for (const resolved of editable) {
+      const raw = input.submitted.get(resolved.field.key)
+      if (raw === undefined) continue
+      values.push({ fieldId: resolved.field.id, value: validate(resolved.field, raw) })
+    }
+
+    if (values.length > 0) {
+      await this.repository.saveValues({ userId: input.userId, values })
+    }
+  }
+
+  async validateRegistration(input: {
+    readonly submitted: ReadonlyMap<string, string>
+    readonly context: ProfileFieldContext
+  }): Promise<readonly ProfileFieldValue[]> {
+    const required = await this.requiredAtRegistration(input.context)
+
+    return required.map((field) => {
+      const raw = (input.submitted.get(field.key) ?? '').trim()
+      if (raw === '')
+        throw new ValidationError(msg('error.profile-fields.required', { label: field.label }))
+      return { fieldId: field.id, value: validate(field, raw) }
+    })
+  }
+
+  async applyRegistration(userId: number, values: readonly ProfileFieldValue[]): Promise<void> {
+    if (values.length === 0) return
+    await this.repository.saveValues({ userId, values })
+  }
+
+  async create(input: {
+    readonly key: string
+    readonly label: string
+    readonly type: string
+    readonly options: readonly string[]
+    readonly requiredAtRegistration?: boolean
+    readonly showInPostbit?: boolean
+    readonly displayOrder?: number
+  }): Promise<ProfileFieldDefinition> {
+    const key = input.key.trim().toLowerCase()
+    if (!/^[a-z][a-z0-9_]{1,39}$/.test(key)) {
+      throw new ValidationError(msg('error.profile-fields.field-key-must-2-40'))
+    }
+
+    const label = input.label.trim()
+    if (label === '') throw new ValidationError(msg('error.profile-fields.field-needs-label'))
+
+    const type = parseType(input.type)
+    if (type === 'select' && input.options.length === 0) {
+      throw new ValidationError(msg('error.profile-fields.dropdown-needs-at-least-one'))
+    }
+
+    if (await this.repository.findByKey(key)) {
+      throw new ValidationError(`A field with the key "${key}" already exists.`)
+    }
+
+    return this.repository.create({
+      key,
+      label,
+      type,
+      options: input.options,
+      requiredAtRegistration: input.requiredAtRegistration ?? false,
+      showInPostbit: input.showInPostbit ?? false,
+      displayOrder: input.displayOrder ?? 0,
+    })
+  }
+
+  async remove(key: string): Promise<boolean> {
+    return this.repository.remove(key.trim().toLowerCase())
+  }
+}
+
+function byField(values: readonly ProfileFieldValue[]): ReadonlyMap<number, string> {
+  return new Map(values.map((value) => [value.fieldId, value.value]))
+}
+
+function parseType(value: string): ProfileFieldDefinition['type'] & string {
+  const type = value.trim().toLowerCase()
+  if (
+    type === 'text' ||
+    type === 'textarea' ||
+    type === 'select' ||
+    type === 'checkbox' ||
+    type === 'url' ||
+    type === 'number'
+  ) {
+    return type
+  }
+  throw new ValidationError(`"${value}" is not a field type.`)
+}
+
+function validate(field: ProfileFieldDefinition, raw: string): string {
+  const value = raw.trim()
+  if (value === '') return ''
+
+  const limit = maxLengthFor(field)
+  if (value.length > limit) {
+    throw new ValidationError(`${field.label} may be at most ${limit} characters.`)
+  }
+
+  switch (field.type) {
+    case 'select':
+      if (!field.options.includes(value)) {
+        throw new ValidationError(`${field.label} must be one of the offered choices.`)
+      }
+      return value
+
+    case 'checkbox':
+      return 'yes'
+
+    case 'number':
+      if (!/^-?\d+(\.\d+)?$/.test(value)) {
+        throw new ValidationError(`${field.label} must be a number.`)
+      }
+      return value
+
+    case 'url':
+      return normaliseUrl(field, value)
+
+    default:
+      return value
+  }
+}
+
+function normaliseUrl(field: ProfileFieldDefinition, value: string): string {
+  const candidate = /^[a-z][a-z0-9+.-]*:/i.test(value) ? value : `https://${value}`
+
+  let url: URL
+  try {
+    url = new URL(candidate)
+  } catch {
+    throw new ValidationError(`${field.label} must be a web address.`)
+  }
+
+  if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+    throw new ValidationError(`${field.label} must start with http:// or https://.`)
+  }
+  return url.toString()
+}

package/src/types.ts

@@ -0,0 +1,78 @@
+export const FIELD_TYPES = ['text', 'textarea', 'select', 'checkbox', 'url', 'number'] as const
+
+export type FieldType = (typeof FIELD_TYPES)[number]
+
+export function parseFieldType(value: string): FieldType | null {
+  return FIELD_TYPES.includes(value as FieldType) ? (value as FieldType) : null
+}
+
+export const DEFAULT_MAX_LENGTH: Readonly<Record<FieldType, number>> = {
+  text: 200,
+  textarea: 2000,
+  select: 100,
+  checkbox: 5,
+  url: 300,
+  number: 20,
+}
+
+export interface ProfileFieldDefinition {
+  readonly id: number
+  readonly key: string
+  readonly label: string
+  readonly description: string | null
+  readonly type: FieldType | null
+  readonly options: readonly string[]
+  readonly maxLength: number | null
+  readonly displayOrder: number
+  readonly isActive: boolean
+  readonly requiredAtRegistration: boolean
+  readonly defaultVisible: boolean
+  readonly defaultEditable: boolean
+  readonly showInPostbit: boolean
+}
+
+export interface ProfileFieldGroupRule {
+  readonly fieldId: number
+  readonly groupId: number
+  readonly canView: boolean | null
+  readonly canEdit: boolean | null
+}
+
+export interface ProfileFieldValue {
+  readonly fieldId: number
+  readonly value: string
+}
+
+export interface ResolvedProfileField {
+  readonly field: ProfileFieldDefinition
+  readonly value: string
+  readonly canView: boolean
+  readonly canEdit: boolean
+}
+
+export interface ProfileFieldRepository {
+  listFields(): Promise<readonly ProfileFieldDefinition[]>
+
+  listGroupRules(): Promise<readonly ProfileFieldGroupRule[]>
+
+  valuesFor(userId: number): Promise<readonly ProfileFieldValue[]>
+
+  saveValues(input: {
+    readonly userId: number
+    readonly values: readonly ProfileFieldValue[]
+  }): Promise<void>
+
+  findByKey(key: string): Promise<ProfileFieldDefinition | null>
+
+  create(input: {
+    readonly key: string
+    readonly label: string
+    readonly type: FieldType
+    readonly options: readonly string[]
+    readonly requiredAtRegistration: boolean
+    readonly showInPostbit: boolean
+    readonly displayOrder: number
+  }): Promise<ProfileFieldDefinition>
+
+  remove(key: string): Promise<boolean>
+}