src/app/features/public-form/public-form-config.ts

Description

Each entity of this type defines a new publicly accessible form that can be reached through the given route even by users without being logged in used in the public forms where we wanted to linked multiple entities in one form.

Extends

Entity

Relationships

Used by

No results matching.

Depends on

Entity

Index

Properties

columns

Use forms array instead for multi-form support

Type : FieldGroup[]

Decorators :


                            @DatabaseField({label: undefined, editComponent: 'EditPublicFormColumns', isArray: true})

Defined in src/app/features/public-form/public-form-config.ts:105

description

Type : string

Decorators :


                            @DatabaseField({label: undefined, dataType: undefined})

Defined in src/app/features/public-form/public-form-config.ts:84

entity

Use forms array instead for multi-form support

Type : string

Decorators :


                            @DatabaseField({label: undefined, description: undefined, editComponent: 'EditEntityType', viewComponent: 'DisplayEntityType', validators: undefined})

Defined in src/app/features/public-form/public-form-config.ts:97

forms

Type : PublicFormEntityFormConfig[]

Decorators :


                            @DatabaseField({label: undefined, isArray: true})

Defined in src/app/features/public-form/public-form-config.ts:126

Static isInternalEntity

Type : unknown

Default value : true

Inherited from Entity

Entity:56

Static label

Type : unknown

Default value : $localize`:PublicFormConfig:Public Form`

Inherited from Entity

Entity:52

Static labelPlural

Type : unknown

Default value : $localize`:PublicFormConfig:Public Forms`

Defined in src/app/features/public-form/public-form-config.ts:53

linkedEntities

Use forms array instead for multi-form support

Type : string[]

Decorators :


                            @DatabaseField({label: undefined, editComponent: 'EditPublicFormRelatedEntitiesComponent', isArray: true})

Defined in src/app/features/public-form/public-form-config.ts:120

logo

Type : string

Decorators :


                            @DatabaseField({label: undefined, description: undefined, dataType: 'file', additional: 300})

Defined in src/app/features/public-form/public-form-config.ts:64

prefilled

Use forms array instead for multi-form support

Type : { }

Decorators :


                            @DatabaseField({label: undefined, editComponent: 'EditPrefilledValuesComponent'})

Defined in src/app/features/public-form/public-form-config.ts:112

Static route

Type : string

Default value : "admin/public-form"

Defined in src/app/features/public-form/public-form-config.ts:54

route

Type : string

Decorators :


                            @DatabaseField({label: undefined, validators: undefined, editComponent: 'EditPublicformRoute'})

Defined in src/app/features/public-form/public-form-config.ts:78

showSubmitAnotherButton

Type : boolean

Default value : false

Decorators :


                            @DatabaseField({label: undefined, description: undefined, dataType: 'boolean'})

Defined in src/app/features/public-form/public-form-config.ts:133

title

Type : string

Decorators :


                            @DatabaseField({label: undefined})

Defined in src/app/features/public-form/public-form-config.ts:69

Static toStringAttributes

Type : []

Default value : ["title"]

Inherited from Entity

Entity:55

Static Optional _isCustomizedType

todo: This property is no longer used and will be removed in future versions.

Type : boolean

Inherited from Entity

Entity:93

True if this type's schema has been customized dynamically from the config.

_rev

Type : string

Decorators :


                            @DatabaseField({anonymize: 'retain', isInternalField: true})

Inherited from Entity

Entity:248

internal database doc revision, used to detect conflicts by PouchDB/CouchDB

anonymized

Type : boolean

Decorators :


                            @DatabaseField({anonymize: 'retain', isInternalField: true})

Inherited from Entity

Entity:269

Whether this entity has been anonymized and therefore cannot be re-activated.

Static color

Type : string | ColorMapping[]

Inherited from Entity

Entity:160

color used for to highlight this entity type across the app.

Can be either:

A simple string (hex color code) for a single color
An array of ColorMapping objects for conditional colors based on entity properties

created

Type : UpdateMetadata

Decorators :


                            @DatabaseField({anonymize: 'retain', isInternalField: true})

Inherited from Entity

Entity:254

Static DATABASE

Type : string

Default value : "app"

Inherited from Entity

Entity:79

The database where these entities are stored.

Static Optional enableUserAccounts

Type : boolean

Inherited from Entity

Entity:124

Whether to enable user account creation for this entity type. When true, the UI will allow management of user accounts associated with this entity.

Static ENTITY_TYPE

Type : string

Default value : "Entity"

Inherited from Entity

Entity:74

The entity's type. In classes extending Entity this is usually overridden by the class annotation @DatabaseEntity('NewEntity'). The type needs to be used as routing path in lower case. The routing path can be defined in the configuration file.

Static hasPII

Type : boolean

Default value : false

Inherited from Entity

Entity:233

whether this entity type can contain "personally identifiable information" (PII) and therefore should follow strict data protection requirements and offer a function to anonymize records.

Static icon

Type : IconName

Inherited from Entity

Entity:151

icon id used for this entity

inactive

Type : boolean

Decorators :


                            @DatabaseField({anonymize: 'retain', isInternalField: true})

Inherited from Entity

Entity:263

Static schema

Type : EntitySchema

Inherited from Entity

Entity:87

EntitySchema defining property transformations from/to the database. This is auto-generated from the property annotations @DatabaseField().

see /additional-documentation/how-to-guides/create-a-new-entity-type.html

Static Optional toBlockDetailsAttributes

Type : EntityBlockConfig

Inherited from Entity

Entity:106

Defining which attributes will be displayed in a tooltip on hover when the record is displayed as an entity-block.

updated

Type : UpdateMetadata

Decorators :


                            @DatabaseField({anonymize: 'retain', isInternalField: true})

Inherited from Entity

Entity:260

Methods

assertValid

assertValid()

Inherited from Entity

Entity:506

Checks if the entity is valid and if the check fails, throws an error explaining the failed check.

Returns : void

Public copy

copy(newId: string | boolean)

Inherited from Entity

Entity:476

Deep copy of the entity. The resulting entity will be of the same type as this (taking into account subclassing). All schema field values that are objects or arrays are deep-cloned to avoid shared mutable state between original and copy.

Parameters :

Name	Type	Optional	Default value	Description
newId	`string \| boolean`	No	`false`	if true, a new entityId will be generated; if a string, that value is used as new entityId

Returns : unknown

Static createPrefixedId

createPrefixedId(type: string, id: string)

Inherited from Entity

Entity:218

Create a prefixed id by adding the type prefix if it isn't already part of the given id.

Parameters :

Name	Type	Optional	Description
type	`string`	No	The type prefix to be added.
id	`string`	No	The id to be extended with a prefix.

Returns : string

Static extractEntityIdFromId

extractEntityIdFromId(id: string)

Inherited from Entity

Entity:197

Extract entityId without prefix.

Parameters :

Name	Type	Optional	Description
id	`string`	No	An entity's id including prefix.

Returns : string

Static extractTypeFromId

extractTypeFromId(id: string)

Inherited from Entity

Entity:183

Extract the ENTITY_TYPE from an id.

Parameters :

Name	Type	Optional	Description
id	`string`	No	An entity's id including prefix.

Returns : string

Public getColor

getColor()

Inherited from Entity

Entity:400

Used by some generic UI components to set the color for the entity instance. Override this method as needed.

Returns : string

Static getColorWithConditions

getColorWithConditions(entity: Entity)

Inherited from Entity

Entity:407

Static method to evaluate conditional colors for an entity based on ColorMapping configuration.

Parameters :

Name	Type	Optional
entity	`Entity`	No

Returns : string

getConstructor

getConstructor()

Inherited from Entity

Entity:330

Get the class (Entity or the actual subclass of the instance) to call static methods on the correct class considering inheritance

Returns : EntityConstructor<unknown>

Public getId

getId(withoutPrefix: unknown)

Inherited from Entity

Entity:349

Returns the id of this entity.

Note that an id is final and can't be changed after the object has been instantiated, hence there is no setId() method.

Parameters :

Name	Type	Optional	Default value
withoutPrefix	`unknown`	No	`false`

Returns : string

the unique id of this entity

getSchema

getSchema()

Inherited from Entity

Entity:337

Get the entity schema of this class

Returns : EntitySchema

Public getType

getType()

Inherited from Entity

Entity:360

Returns the type which is used to categorize this entity in the database.

Important: Do not overwrite this method! Types are handled internally.

Returns : string

the entity's type (which is the class name).

Public getWarningLevel

getWarningLevel()

Inherited from Entity

Entity:463

Override getWarningLevel() to define when the entity is in a critical condition and should be color-coded and highlighted in generic components of the UI.

Returns : WarningLevel

Accessors

isActive

getisActive()

Defined in src/app/features/public-form/public-form-config.ts:135

import { Entity } from "../../core/entity/model/entity";
import { DatabaseEntity } from "../../core/entity/database-entity.decorator";
import { DatabaseField } from "../../core/entity/database-field.decorator";
import { LongTextDatatype } from "app/core/basic-datatypes/string/long-text.datatype";
import { FieldGroup } from "app/core/entity-details/form/field-group";
import { DefaultValueConfig } from "#src/app/core/default-values/default-value-config";

/**
 * Configuration for a single entity form within a public form.
 * Supports multiple entity types in one public form submission.
 */
export interface PublicFormEntityFormConfig {
  /**
   * The type of record that is created when someone submits the form.
   * (e.g. if you select "Note" here, the form will create new entries in your "Notes List"
   * and you can select only fields of your "Note" data structure for this form)
   */
  entity: string;

  /**
   * Fields to display in the form, organized into field groups/columns.
   */
  columns: FieldGroup[];

  /**
   * Fields with default/prefilled values.
   * Key is the field ID, value is the default value configuration.
   */
  prefilled?: { [key: string]: DefaultValueConfig };

  /**
   * Field IDs that link to other entities in the same form submission.
   * These fields will be automatically populated with IDs of entities created
   * by other forms in the same submission or passed as URL parameters.
   */
  linkedEntities?: string[];

  /**
   * Field IDs that should be linked from other forms in the same submission.
   * Uses schema metadata to decide which form's entity ID to apply.
   */
  linkedFromForm?: string[];
}

/**
 * Each entity of this type defines a new publicly accessible form
 * that can be reached through the given route even by users without being logged in
 * used in the public forms where we wanted to linked multiple entities in one form.
 */
@DatabaseEntity("PublicFormConfig")
export class PublicFormConfig extends Entity {
  static override label = $localize`:PublicFormConfig:Public Form`;
  static override labelPlural = $localize`:PublicFormConfig:Public Forms`;
  static override route = "admin/public-form";
  static override toStringAttributes = ["title"];
  static override isInternalEntity = true;

  @DatabaseField({
    label: $localize`:PublicFormConfig:Form Logo`,
    description: $localize`:PublicFormConfig:Add an image to be displayed at the top of the form`,
    dataType: "file",
    additional: 300,
  })
  logo: string;

  @DatabaseField({
    label: $localize`:PublicFormConfig:Title`,
  })
  title: string;

  @DatabaseField({
    label: $localize`:PublicFormConfig:Form Link ID`,
    validators: {
      required: true,
    },
    editComponent: "EditPublicformRoute",
  })
  route: string;

  @DatabaseField({
    label: $localize`:PublicFormConfig:Description`,
    dataType: LongTextDatatype.dataType,
  })
  description: string;

  /** @deprecated Use `forms` array instead for multi-form support */
  @DatabaseField({
    label: $localize`:PublicFormConfig:Record`,
    description: $localize`:PublicFormConfig:The type of record that is created when a someone submits the form (e.g. if you select "Note" here, the form will create new entries in your "Notes List" and you can select only fields of your "Note" data structure for this form)`,
    editComponent: "EditEntityType",
    viewComponent: "DisplayEntityType",
    validators: {
      required: true,
      readonlyAfterSet: true,
    },
  })
  entity: string;

  /** @deprecated Use `forms` array instead for multi-form support */
  @DatabaseField({
    label: $localize`:PublicFormConfig:Fields`,
    editComponent: "EditPublicFormColumns",
    isArray: true,
  })
  columns: FieldGroup[];

  /** @deprecated Use `forms` array instead for multi-form support */
  @DatabaseField({
    label: $localize`:PublicFormConfig:Prefilled Fields`,
    editComponent: "EditPrefilledValuesComponent",
  })
  prefilled: { [key: string]: DefaultValueConfig };

  /** @deprecated Use `forms` array instead for multi-form support */
  @DatabaseField({
    label: $localize`:PublicFormConfig:Linked Entities`,
    editComponent: "EditPublicFormRelatedEntitiesComponent",
    isArray: true,
  })
  linkedEntities: string[];

  @DatabaseField({
    label: $localize`:PublicFormConfig:Multiple Forms`,
    isArray: true,
  })
  forms: PublicFormEntityFormConfig[];

  @DatabaseField({
    label: $localize`:PublicFormConfig:Show "Submit Another Form" Button`,
    description: $localize`:PublicFormConfig:If enabled, users will see a "Submit Another Form" button after a successful submission. This helps when you want multiple submissions from the same user.`,
    dataType: "boolean",
  })
  showSubmitAnotherButton: boolean = false;

  override get isActive(): boolean {
    // hide the new style public forms (nested `forms` array) because the Admin UI is not ready yet
    // TODO: remove after implementing https://github.com/Aam-Digital/ndb-core/issues/3610
    if (this.forms?.length) {
      return false;
    }

    return super.isActive;
  }
}

Description

Extends

Relationships

Used by

Depends on

Index

Properties

Methods

Accessors

Properties

Methods

Accessors

results matching ""

No results matching ""